Class PlaybooksSettings (0.46.0) 

public class PlaybooksSettings extends ClientSettings<PlaybooksSettings>

Settings class to configure an instance of PlaybooksClient.

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 createPlaybook 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
 PlaybooksSettings.Builder playbooksSettingsBuilder = PlaybooksSettings.newBuilder();
 playbooksSettingsBuilder
     .createPlaybookSettings()
     .setRetrySettings(
         playbooksSettingsBuilder
             .createPlaybookSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 PlaybooksSettings playbooksSettings = playbooksSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > PlaybooksSettings

Static Methods

create(PlaybooksStubSettings stub)

public static final PlaybooksSettings create(PlaybooksStubSettings stub)
Parameter
Name Description
stub PlaybooksStubSettings
Returns
Type Description
PlaybooksSettings
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 PlaybooksSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
PlaybooksSettings.Builder

newBuilder(ClientContext clientContext)

public static PlaybooksSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
PlaybooksSettings.Builder

newHttpJsonBuilder()

public static PlaybooksSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
PlaybooksSettings.Builder

Constructors

PlaybooksSettings(PlaybooksSettings.Builder settingsBuilder)

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

Methods

createPlaybookSettings()

public UnaryCallSettings<CreatePlaybookRequest,Playbook> createPlaybookSettings()

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

Returns
Type Description
UnaryCallSettings<CreatePlaybookRequest,Playbook>

createPlaybookVersionSettings()

public UnaryCallSettings<CreatePlaybookVersionRequest,PlaybookVersion> createPlaybookVersionSettings()

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

Returns
Type Description
UnaryCallSettings<CreatePlaybookVersionRequest,PlaybookVersion>

deletePlaybookSettings()

public UnaryCallSettings<DeletePlaybookRequest,Empty> deletePlaybookSettings()

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

Returns
Type Description
UnaryCallSettings<DeletePlaybookRequest,Empty>

deletePlaybookVersionSettings()

public UnaryCallSettings<DeletePlaybookVersionRequest,Empty> deletePlaybookVersionSettings()

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

Returns
Type Description
UnaryCallSettings<DeletePlaybookVersionRequest,Empty>

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>

getPlaybookSettings()

public UnaryCallSettings<GetPlaybookRequest,Playbook> getPlaybookSettings()

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

Returns
Type Description
UnaryCallSettings<GetPlaybookRequest,Playbook>

getPlaybookVersionSettings()

public UnaryCallSettings<GetPlaybookVersionRequest,PlaybookVersion> getPlaybookVersionSettings()

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

Returns
Type Description
UnaryCallSettings<GetPlaybookVersionRequest,PlaybookVersion>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,PlaybooksClient.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>

listPlaybookVersionsSettings()

public PagedCallSettings<ListPlaybookVersionsRequest,ListPlaybookVersionsResponse,PlaybooksClient.ListPlaybookVersionsPagedResponse> listPlaybookVersionsSettings()

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

Returns
Type Description
PagedCallSettings<ListPlaybookVersionsRequest,ListPlaybookVersionsResponse,ListPlaybookVersionsPagedResponse>

listPlaybooksSettings()

public PagedCallSettings<ListPlaybooksRequest,ListPlaybooksResponse,PlaybooksClient.ListPlaybooksPagedResponse> listPlaybooksSettings()

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

Returns
Type Description
PagedCallSettings<ListPlaybooksRequest,ListPlaybooksResponse,ListPlaybooksPagedResponse>

toBuilder()

public PlaybooksSettings.Builder toBuilder()

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

Returns
Type Description
PlaybooksSettings.Builder
Overrides

updatePlaybookSettings()

public UnaryCallSettings<UpdatePlaybookRequest,Playbook> updatePlaybookSettings()

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

Returns
Type Description
UnaryCallSettings<UpdatePlaybookRequest,Playbook>