Class FlowsSettings
- java.lang.Object
-
- com.google.api.gax.rpc.ClientSettings<FlowsSettings>
-
- com.google.cloud.dialogflow.cx.v3.FlowsSettings
-
@Generated("by gapic-generator-java") public class FlowsSettings extends com.google.api.gax.rpc.ClientSettings<FlowsSettings>
Settings class to configure an instance ofFlowsClient
.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 total timeout of createFlow 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 FlowsSettings.Builder flowsSettingsBuilder = FlowsSettings.newBuilder(); flowsSettingsBuilder .createFlowSettings() .setRetrySettings( flowsSettingsBuilder .createFlowSettings() .getRetrySettings() .toBuilder() .setTotalTimeout(Duration.ofSeconds(30)) .build()); FlowsSettings flowsSettings = flowsSettingsBuilder.build();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FlowsSettings.Builder
Builder for FlowsSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protected
FlowsSettings(FlowsSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FlowsSettings
create(FlowsStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreateFlowRequest,Flow>
createFlowSettings()
Returns the object with the settings used for calls to createFlow.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.UnaryCallSettings<DeleteFlowRequest,com.google.protobuf.Empty>
deleteFlowSettings()
Returns the object with the settings used for calls to deleteFlow.com.google.api.gax.rpc.OperationCallSettings<ExportFlowRequest,ExportFlowResponse,com.google.protobuf.Struct>
exportFlowOperationSettings()
Returns the object with the settings used for calls to exportFlow.com.google.api.gax.rpc.UnaryCallSettings<ExportFlowRequest,com.google.longrunning.Operation>
exportFlowSettings()
Returns the object with the settings used for calls to exportFlow.static String
getDefaultEndpoint()
Returns the default service endpoint.static List<String>
getDefaultServiceScopes()
Returns the default service scopes.com.google.api.gax.rpc.UnaryCallSettings<GetFlowRequest,Flow>
getFlowSettings()
Returns the object with the settings used for calls to getFlow.com.google.api.gax.rpc.UnaryCallSettings<GetFlowValidationResultRequest,FlowValidationResult>
getFlowValidationResultSettings()
Returns the object with the settings used for calls to getFlowValidationResult.com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>
getLocationSettings()
Returns the object with the settings used for calls to getLocation.com.google.api.gax.rpc.OperationCallSettings<ImportFlowRequest,ImportFlowResponse,com.google.protobuf.Struct>
importFlowOperationSettings()
Returns the object with the settings used for calls to importFlow.com.google.api.gax.rpc.UnaryCallSettings<ImportFlowRequest,com.google.longrunning.Operation>
importFlowSettings()
Returns the object with the settings used for calls to importFlow.com.google.api.gax.rpc.PagedCallSettings<ListFlowsRequest,ListFlowsResponse,FlowsClient.ListFlowsPagedResponse>
listFlowsSettings()
Returns the object with the settings used for calls to listFlows.com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,FlowsClient.ListLocationsPagedResponse>
listLocationsSettings()
Returns the object with the settings used for calls to listLocations.static FlowsSettings.Builder
newBuilder()
Returns a new gRPC builder for this class.static FlowsSettings.Builder
newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.static FlowsSettings.Builder
newHttpJsonBuilder()
Returns a new REST builder for this class.FlowsSettings.Builder
toBuilder()
Returns a builder containing all the values of this settings class.com.google.api.gax.rpc.OperationCallSettings<TrainFlowRequest,com.google.protobuf.Empty,com.google.protobuf.Struct>
trainFlowOperationSettings()
Returns the object with the settings used for calls to trainFlow.com.google.api.gax.rpc.UnaryCallSettings<TrainFlowRequest,com.google.longrunning.Operation>
trainFlowSettings()
Returns the object with the settings used for calls to trainFlow.com.google.api.gax.rpc.UnaryCallSettings<UpdateFlowRequest,Flow>
updateFlowSettings()
Returns the object with the settings used for calls to updateFlow.com.google.api.gax.rpc.UnaryCallSettings<ValidateFlowRequest,FlowValidationResult>
validateFlowSettings()
Returns the object with the settings used for calls to validateFlow.-
Methods inherited from class com.google.api.gax.rpc.ClientSettings
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString
-
-
-
-
Constructor Detail
-
FlowsSettings
protected FlowsSettings(FlowsSettings.Builder settingsBuilder) throws IOException
- Throws:
IOException
-
-
Method Detail
-
createFlowSettings
public com.google.api.gax.rpc.UnaryCallSettings<CreateFlowRequest,Flow> createFlowSettings()
Returns the object with the settings used for calls to createFlow.
-
deleteFlowSettings
public com.google.api.gax.rpc.UnaryCallSettings<DeleteFlowRequest,com.google.protobuf.Empty> deleteFlowSettings()
Returns the object with the settings used for calls to deleteFlow.
-
listFlowsSettings
public com.google.api.gax.rpc.PagedCallSettings<ListFlowsRequest,ListFlowsResponse,FlowsClient.ListFlowsPagedResponse> listFlowsSettings()
Returns the object with the settings used for calls to listFlows.
-
getFlowSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetFlowRequest,Flow> getFlowSettings()
Returns the object with the settings used for calls to getFlow.
-
updateFlowSettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateFlowRequest,Flow> updateFlowSettings()
Returns the object with the settings used for calls to updateFlow.
-
trainFlowSettings
public com.google.api.gax.rpc.UnaryCallSettings<TrainFlowRequest,com.google.longrunning.Operation> trainFlowSettings()
Returns the object with the settings used for calls to trainFlow.
-
trainFlowOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<TrainFlowRequest,com.google.protobuf.Empty,com.google.protobuf.Struct> trainFlowOperationSettings()
Returns the object with the settings used for calls to trainFlow.
-
validateFlowSettings
public com.google.api.gax.rpc.UnaryCallSettings<ValidateFlowRequest,FlowValidationResult> validateFlowSettings()
Returns the object with the settings used for calls to validateFlow.
-
getFlowValidationResultSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetFlowValidationResultRequest,FlowValidationResult> getFlowValidationResultSettings()
Returns the object with the settings used for calls to getFlowValidationResult.
-
importFlowSettings
public com.google.api.gax.rpc.UnaryCallSettings<ImportFlowRequest,com.google.longrunning.Operation> importFlowSettings()
Returns the object with the settings used for calls to importFlow.
-
importFlowOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<ImportFlowRequest,ImportFlowResponse,com.google.protobuf.Struct> importFlowOperationSettings()
Returns the object with the settings used for calls to importFlow.
-
exportFlowSettings
public com.google.api.gax.rpc.UnaryCallSettings<ExportFlowRequest,com.google.longrunning.Operation> exportFlowSettings()
Returns the object with the settings used for calls to exportFlow.
-
exportFlowOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<ExportFlowRequest,ExportFlowResponse,com.google.protobuf.Struct> exportFlowOperationSettings()
Returns the object with the settings used for calls to exportFlow.
-
listLocationsSettings
public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,FlowsClient.ListLocationsPagedResponse> listLocationsSettings()
Returns the object with the settings used for calls to listLocations.
-
getLocationSettings
public com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationSettings()
Returns the object with the settings used for calls to getLocation.
-
create
public static final FlowsSettings create(FlowsStubSettings 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
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.") public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
-
newBuilder
public static FlowsSettings.Builder newBuilder()
Returns a new gRPC builder for this class.
-
newHttpJsonBuilder
@BetaApi public static FlowsSettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
-
newBuilder
public static FlowsSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
-
toBuilder
public FlowsSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.- Specified by:
toBuilder
in classcom.google.api.gax.rpc.ClientSettings<FlowsSettings>
-
-