Class EntityTypesSettings (4.57.0) 

public class EntityTypesSettings extends ClientSettings<EntityTypesSettings>

Settings class to configure an instance of EntityTypesClient.

The default instance has everything set to sensible defaults:

  • The default service address (dialogflow.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 RetrySettings of getEntityType:


 // 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
 EntityTypesSettings.Builder entityTypesSettingsBuilder = EntityTypesSettings.newBuilder();
 entityTypesSettingsBuilder
     .getEntityTypeSettings()
     .setRetrySettings(
         entityTypesSettingsBuilder
             .getEntityTypeSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 EntityTypesSettings entityTypesSettings = entityTypesSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for batchUpdateEntityTypes:


 // 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
 EntityTypesSettings.Builder entityTypesSettingsBuilder = EntityTypesSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 entityTypesSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > ClientSettings > EntityTypesSettings

Static Methods

create(EntityTypesStubSettings stub)

public static final EntityTypesSettings create(EntityTypesStubSettings stub)
Parameter
Name Description
stub EntityTypesStubSettings
Returns
Type Description
EntityTypesSettings
Exceptions
Type Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static EntityTypesSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
EntityTypesSettings.Builder

newBuilder(ClientContext clientContext)

public static EntityTypesSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
EntityTypesSettings.Builder

newHttpJsonBuilder()

public static EntityTypesSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
EntityTypesSettings.Builder

Constructors

EntityTypesSettings(EntityTypesSettings.Builder settingsBuilder)

protected EntityTypesSettings(EntityTypesSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder EntityTypesSettings.Builder

Methods

batchCreateEntitiesOperationSettings()

public OperationCallSettings<BatchCreateEntitiesRequest,Empty,Struct> batchCreateEntitiesOperationSettings()

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

Returns
Type Description
OperationCallSettings<BatchCreateEntitiesRequest,Empty,Struct>

batchCreateEntitiesSettings()

public UnaryCallSettings<BatchCreateEntitiesRequest,Operation> batchCreateEntitiesSettings()

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

Returns
Type Description
UnaryCallSettings<BatchCreateEntitiesRequest,Operation>

batchDeleteEntitiesOperationSettings()

public OperationCallSettings<BatchDeleteEntitiesRequest,Empty,Struct> batchDeleteEntitiesOperationSettings()

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

Returns
Type Description
OperationCallSettings<BatchDeleteEntitiesRequest,Empty,Struct>

batchDeleteEntitiesSettings()

public UnaryCallSettings<BatchDeleteEntitiesRequest,Operation> batchDeleteEntitiesSettings()

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

Returns
Type Description
UnaryCallSettings<BatchDeleteEntitiesRequest,Operation>

batchDeleteEntityTypesOperationSettings()

public OperationCallSettings<BatchDeleteEntityTypesRequest,Empty,Struct> batchDeleteEntityTypesOperationSettings()

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

Returns
Type Description
OperationCallSettings<BatchDeleteEntityTypesRequest,Empty,Struct>

batchDeleteEntityTypesSettings()

public UnaryCallSettings<BatchDeleteEntityTypesRequest,Operation> batchDeleteEntityTypesSettings()

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

Returns
Type Description
UnaryCallSettings<BatchDeleteEntityTypesRequest,Operation>

batchUpdateEntitiesOperationSettings()

public OperationCallSettings<BatchUpdateEntitiesRequest,Empty,Struct> batchUpdateEntitiesOperationSettings()

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

Returns
Type Description
OperationCallSettings<BatchUpdateEntitiesRequest,Empty,Struct>

batchUpdateEntitiesSettings()

public UnaryCallSettings<BatchUpdateEntitiesRequest,Operation> batchUpdateEntitiesSettings()

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

Returns
Type Description
UnaryCallSettings<BatchUpdateEntitiesRequest,Operation>

batchUpdateEntityTypesOperationSettings()

public OperationCallSettings<BatchUpdateEntityTypesRequest,BatchUpdateEntityTypesResponse,Struct> batchUpdateEntityTypesOperationSettings()

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

Returns
Type Description
OperationCallSettings<BatchUpdateEntityTypesRequest,BatchUpdateEntityTypesResponse,Struct>

batchUpdateEntityTypesSettings()

public UnaryCallSettings<BatchUpdateEntityTypesRequest,Operation> batchUpdateEntityTypesSettings()

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

Returns
Type Description
UnaryCallSettings<BatchUpdateEntityTypesRequest,Operation>

createEntityTypeSettings()

public UnaryCallSettings<CreateEntityTypeRequest,EntityType> createEntityTypeSettings()

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

Returns
Type Description
UnaryCallSettings<CreateEntityTypeRequest,EntityType>

deleteEntityTypeSettings()

public UnaryCallSettings<DeleteEntityTypeRequest,Empty> deleteEntityTypeSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteEntityTypeRequest,Empty>

getEntityTypeSettings()

public UnaryCallSettings<GetEntityTypeRequest,EntityType> getEntityTypeSettings()

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

Returns
Type Description
UnaryCallSettings<GetEntityTypeRequest,EntityType>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

listEntityTypesSettings()

public PagedCallSettings<ListEntityTypesRequest,ListEntityTypesResponse,EntityTypesClient.ListEntityTypesPagedResponse> listEntityTypesSettings()

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

Returns
Type Description
PagedCallSettings<ListEntityTypesRequest,ListEntityTypesResponse,ListEntityTypesPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,EntityTypesClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
Type Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

toBuilder()

public EntityTypesSettings.Builder toBuilder()

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

Returns
Type Description
EntityTypesSettings.Builder
Overrides

updateEntityTypeSettings()

public UnaryCallSettings<UpdateEntityTypeRequest,EntityType> updateEntityTypeSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateEntityTypeRequest,EntityType>