Class ConfigDeliverySettings (0.1.0) 

public class ConfigDeliverySettings extends ClientSettings<ConfigDeliverySettings>

Settings class to configure an instance of ConfigDeliveryClient.

The default instance has everything set to sensible defaults:

  • The default service address (configdelivery.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 getResourceBundle:


 // 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
 ConfigDeliverySettings.Builder configDeliverySettingsBuilder =
     ConfigDeliverySettings.newBuilder();
 configDeliverySettingsBuilder
     .getResourceBundleSettings()
     .setRetrySettings(
         configDeliverySettingsBuilder
             .getResourceBundleSettings()
             .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());
 ConfigDeliverySettings configDeliverySettings = configDeliverySettingsBuilder.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 createResourceBundle:


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

Inheritance

java.lang.Object > ClientSettings > ConfigDeliverySettings

Static Methods

create(ConfigDeliveryStubSettings stub)

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

Returns a new gRPC builder for this class.

Returns
Type Description
ConfigDeliverySettings.Builder

newBuilder(ClientContext clientContext)

public static ConfigDeliverySettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
ConfigDeliverySettings.Builder

newHttpJsonBuilder()

public static ConfigDeliverySettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
ConfigDeliverySettings.Builder

Constructors

ConfigDeliverySettings(ConfigDeliverySettings.Builder settingsBuilder)

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

Methods

abortRolloutOperationSettings()

public OperationCallSettings<AbortRolloutRequest,Rollout,OperationMetadata> abortRolloutOperationSettings()

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

Returns
Type Description
OperationCallSettings<AbortRolloutRequest,Rollout,OperationMetadata>

abortRolloutSettings()

public UnaryCallSettings<AbortRolloutRequest,Operation> abortRolloutSettings()

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

Returns
Type Description
UnaryCallSettings<AbortRolloutRequest,Operation>

createFleetPackageOperationSettings()

public OperationCallSettings<CreateFleetPackageRequest,FleetPackage,OperationMetadata> createFleetPackageOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateFleetPackageRequest,FleetPackage,OperationMetadata>

createFleetPackageSettings()

public UnaryCallSettings<CreateFleetPackageRequest,Operation> createFleetPackageSettings()

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

Returns
Type Description
UnaryCallSettings<CreateFleetPackageRequest,Operation>

createReleaseOperationSettings()

public OperationCallSettings<CreateReleaseRequest,Release,OperationMetadata> createReleaseOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateReleaseRequest,Release,OperationMetadata>

createReleaseSettings()

public UnaryCallSettings<CreateReleaseRequest,Operation> createReleaseSettings()

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

Returns
Type Description
UnaryCallSettings<CreateReleaseRequest,Operation>

createResourceBundleOperationSettings()

public OperationCallSettings<CreateResourceBundleRequest,ResourceBundle,OperationMetadata> createResourceBundleOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateResourceBundleRequest,ResourceBundle,OperationMetadata>

createResourceBundleSettings()

public UnaryCallSettings<CreateResourceBundleRequest,Operation> createResourceBundleSettings()

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

Returns
Type Description
UnaryCallSettings<CreateResourceBundleRequest,Operation>

createVariantOperationSettings()

public OperationCallSettings<CreateVariantRequest,Variant,OperationMetadata> createVariantOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateVariantRequest,Variant,OperationMetadata>

createVariantSettings()

public UnaryCallSettings<CreateVariantRequest,Operation> createVariantSettings()

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

Returns
Type Description
UnaryCallSettings<CreateVariantRequest,Operation>

deleteFleetPackageOperationSettings()

public OperationCallSettings<DeleteFleetPackageRequest,Empty,OperationMetadata> deleteFleetPackageOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteFleetPackageRequest,Empty,OperationMetadata>

deleteFleetPackageSettings()

public UnaryCallSettings<DeleteFleetPackageRequest,Operation> deleteFleetPackageSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteFleetPackageRequest,Operation>

deleteReleaseOperationSettings()

public OperationCallSettings<DeleteReleaseRequest,Empty,OperationMetadata> deleteReleaseOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteReleaseRequest,Empty,OperationMetadata>

deleteReleaseSettings()

public UnaryCallSettings<DeleteReleaseRequest,Operation> deleteReleaseSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteReleaseRequest,Operation>

deleteResourceBundleOperationSettings()

public OperationCallSettings<DeleteResourceBundleRequest,Empty,OperationMetadata> deleteResourceBundleOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteResourceBundleRequest,Empty,OperationMetadata>

deleteResourceBundleSettings()

public UnaryCallSettings<DeleteResourceBundleRequest,Operation> deleteResourceBundleSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteResourceBundleRequest,Operation>

deleteVariantOperationSettings()

public OperationCallSettings<DeleteVariantRequest,Empty,OperationMetadata> deleteVariantOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteVariantRequest,Empty,OperationMetadata>

deleteVariantSettings()

public UnaryCallSettings<DeleteVariantRequest,Operation> deleteVariantSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteVariantRequest,Operation>

getFleetPackageSettings()

public UnaryCallSettings<GetFleetPackageRequest,FleetPackage> getFleetPackageSettings()

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

Returns
Type Description
UnaryCallSettings<GetFleetPackageRequest,FleetPackage>

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>

getReleaseSettings()

public UnaryCallSettings<GetReleaseRequest,Release> getReleaseSettings()

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

Returns
Type Description
UnaryCallSettings<GetReleaseRequest,Release>

getResourceBundleSettings()

public UnaryCallSettings<GetResourceBundleRequest,ResourceBundle> getResourceBundleSettings()

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

Returns
Type Description
UnaryCallSettings<GetResourceBundleRequest,ResourceBundle>

getRolloutSettings()

public UnaryCallSettings<GetRolloutRequest,Rollout> getRolloutSettings()

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

Returns
Type Description
UnaryCallSettings<GetRolloutRequest,Rollout>

getVariantSettings()

public UnaryCallSettings<GetVariantRequest,Variant> getVariantSettings()

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

Returns
Type Description
UnaryCallSettings<GetVariantRequest,Variant>

listFleetPackagesSettings()

public PagedCallSettings<ListFleetPackagesRequest,ListFleetPackagesResponse,ConfigDeliveryClient.ListFleetPackagesPagedResponse> listFleetPackagesSettings()

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

Returns
Type Description
PagedCallSettings<ListFleetPackagesRequest,ListFleetPackagesResponse,ListFleetPackagesPagedResponse>

listLocationsSettings()

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

listReleasesSettings()

public PagedCallSettings<ListReleasesRequest,ListReleasesResponse,ConfigDeliveryClient.ListReleasesPagedResponse> listReleasesSettings()

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

Returns
Type Description
PagedCallSettings<ListReleasesRequest,ListReleasesResponse,ListReleasesPagedResponse>

listResourceBundlesSettings()

public PagedCallSettings<ListResourceBundlesRequest,ListResourceBundlesResponse,ConfigDeliveryClient.ListResourceBundlesPagedResponse> listResourceBundlesSettings()

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

Returns
Type Description
PagedCallSettings<ListResourceBundlesRequest,ListResourceBundlesResponse,ListResourceBundlesPagedResponse>

listRolloutsSettings()

public PagedCallSettings<ListRolloutsRequest,ListRolloutsResponse,ConfigDeliveryClient.ListRolloutsPagedResponse> listRolloutsSettings()

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

Returns
Type Description
PagedCallSettings<ListRolloutsRequest,ListRolloutsResponse,ListRolloutsPagedResponse>

listVariantsSettings()

public PagedCallSettings<ListVariantsRequest,ListVariantsResponse,ConfigDeliveryClient.ListVariantsPagedResponse> listVariantsSettings()

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

Returns
Type Description
PagedCallSettings<ListVariantsRequest,ListVariantsResponse,ListVariantsPagedResponse>

resumeRolloutOperationSettings()

public OperationCallSettings<ResumeRolloutRequest,Rollout,OperationMetadata> resumeRolloutOperationSettings()

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

Returns
Type Description
OperationCallSettings<ResumeRolloutRequest,Rollout,OperationMetadata>

resumeRolloutSettings()

public UnaryCallSettings<ResumeRolloutRequest,Operation> resumeRolloutSettings()

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

Returns
Type Description
UnaryCallSettings<ResumeRolloutRequest,Operation>

suspendRolloutOperationSettings()

public OperationCallSettings<SuspendRolloutRequest,Rollout,OperationMetadata> suspendRolloutOperationSettings()

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

Returns
Type Description
OperationCallSettings<SuspendRolloutRequest,Rollout,OperationMetadata>

suspendRolloutSettings()

public UnaryCallSettings<SuspendRolloutRequest,Operation> suspendRolloutSettings()

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

Returns
Type Description
UnaryCallSettings<SuspendRolloutRequest,Operation>

toBuilder()

public ConfigDeliverySettings.Builder toBuilder()

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

Returns
Type Description
ConfigDeliverySettings.Builder
Overrides

updateFleetPackageOperationSettings()

public OperationCallSettings<UpdateFleetPackageRequest,FleetPackage,OperationMetadata> updateFleetPackageOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateFleetPackageRequest,FleetPackage,OperationMetadata>

updateFleetPackageSettings()

public UnaryCallSettings<UpdateFleetPackageRequest,Operation> updateFleetPackageSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateFleetPackageRequest,Operation>

updateReleaseOperationSettings()

public OperationCallSettings<UpdateReleaseRequest,Release,OperationMetadata> updateReleaseOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateReleaseRequest,Release,OperationMetadata>

updateReleaseSettings()

public UnaryCallSettings<UpdateReleaseRequest,Operation> updateReleaseSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateReleaseRequest,Operation>

updateResourceBundleOperationSettings()

public OperationCallSettings<UpdateResourceBundleRequest,ResourceBundle,OperationMetadata> updateResourceBundleOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateResourceBundleRequest,ResourceBundle,OperationMetadata>

updateResourceBundleSettings()

public UnaryCallSettings<UpdateResourceBundleRequest,Operation> updateResourceBundleSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateResourceBundleRequest,Operation>

updateVariantOperationSettings()

public OperationCallSettings<UpdateVariantRequest,Variant,OperationMetadata> updateVariantOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateVariantRequest,Variant,OperationMetadata>

updateVariantSettings()

public UnaryCallSettings<UpdateVariantRequest,Operation> updateVariantSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateVariantRequest,Operation>