Class TelcoAutomationSettings (0.22.0)

public class TelcoAutomationSettings extends ClientSettings<TelcoAutomationSettings>

Settings class to configure an instance of TelcoAutomationClient.

The default instance has everything set to sensible defaults:

The default service address (telcoautomation.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 getOrchestrationCluster:


 // 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
 TelcoAutomationSettings.Builder telcoAutomationSettingsBuilder =
     TelcoAutomationSettings.newBuilder();
 telcoAutomationSettingsBuilder
     .getOrchestrationClusterSettings()
     .setRetrySettings(
         telcoAutomationSettingsBuilder
             .getOrchestrationClusterSettings()
             .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());
 TelcoAutomationSettings telcoAutomationSettings = telcoAutomationSettingsBuilder.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 createOrchestrationCluster:


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

Inheritance

java.lang.Object > ClientSettings > TelcoAutomationSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getApiKey()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogCheckIntervalDuration()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(TelcoAutomationStubSettings stub)

public static final TelcoAutomationSettings create(TelcoAutomationStubSettings stub)

Parameter
Name	Description
`stub`	`TelcoAutomationStubSettings`

Returns
Type	Description
`TelcoAutomationSettings`

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 TelcoAutomationSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
`TelcoAutomationSettings.Builder`

newBuilder(ClientContext clientContext)

public static TelcoAutomationSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`TelcoAutomationSettings.Builder`

newHttpJsonBuilder()

public static TelcoAutomationSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
`TelcoAutomationSettings.Builder`

Constructors

TelcoAutomationSettings(TelcoAutomationSettings.Builder settingsBuilder)

protected TelcoAutomationSettings(TelcoAutomationSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`TelcoAutomationSettings.Builder`

Methods

applyDeploymentSettings()

public UnaryCallSettings<ApplyDeploymentRequest,Deployment> applyDeploymentSettings()

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

Returns
Type	Description
`UnaryCallSettings<ApplyDeploymentRequest,Deployment>`

applyHydratedDeploymentSettings()

public UnaryCallSettings<ApplyHydratedDeploymentRequest,HydratedDeployment> applyHydratedDeploymentSettings()

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

Returns
Type	Description
`UnaryCallSettings<ApplyHydratedDeploymentRequest,HydratedDeployment>`

approveBlueprintSettings()

public UnaryCallSettings<ApproveBlueprintRequest,Blueprint> approveBlueprintSettings()

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

Returns
Type	Description
`UnaryCallSettings<ApproveBlueprintRequest,Blueprint>`

computeDeploymentStatusSettings()

public UnaryCallSettings<ComputeDeploymentStatusRequest,ComputeDeploymentStatusResponse> computeDeploymentStatusSettings()

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

Returns
Type	Description
`UnaryCallSettings<ComputeDeploymentStatusRequest,ComputeDeploymentStatusResponse>`

createBlueprintSettings()

public UnaryCallSettings<CreateBlueprintRequest,Blueprint> createBlueprintSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateBlueprintRequest,Blueprint>`

createDeploymentSettings()

public UnaryCallSettings<CreateDeploymentRequest,Deployment> createDeploymentSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateDeploymentRequest,Deployment>`

createEdgeSlmOperationSettings()

public OperationCallSettings<CreateEdgeSlmRequest,EdgeSlm,OperationMetadata> createEdgeSlmOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateEdgeSlmRequest,EdgeSlm,OperationMetadata>`

createEdgeSlmSettings()

public UnaryCallSettings<CreateEdgeSlmRequest,Operation> createEdgeSlmSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateEdgeSlmRequest,Operation>`

createOrchestrationClusterOperationSettings()

public OperationCallSettings<CreateOrchestrationClusterRequest,OrchestrationCluster,OperationMetadata> createOrchestrationClusterOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateOrchestrationClusterRequest,OrchestrationCluster,OperationMetadata>`

createOrchestrationClusterSettings()

public UnaryCallSettings<CreateOrchestrationClusterRequest,Operation> createOrchestrationClusterSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateOrchestrationClusterRequest,Operation>`

deleteBlueprintSettings()

public UnaryCallSettings<DeleteBlueprintRequest,Empty> deleteBlueprintSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteBlueprintRequest,Empty>`

deleteEdgeSlmOperationSettings()

public OperationCallSettings<DeleteEdgeSlmRequest,Empty,OperationMetadata> deleteEdgeSlmOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeleteEdgeSlmRequest,Empty,OperationMetadata>`

deleteEdgeSlmSettings()

public UnaryCallSettings<DeleteEdgeSlmRequest,Operation> deleteEdgeSlmSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteEdgeSlmRequest,Operation>`

deleteOrchestrationClusterOperationSettings()

public OperationCallSettings<DeleteOrchestrationClusterRequest,Empty,OperationMetadata> deleteOrchestrationClusterOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeleteOrchestrationClusterRequest,Empty,OperationMetadata>`

deleteOrchestrationClusterSettings()

public UnaryCallSettings<DeleteOrchestrationClusterRequest,Operation> deleteOrchestrationClusterSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteOrchestrationClusterRequest,Operation>`

discardBlueprintChangesSettings()

public UnaryCallSettings<DiscardBlueprintChangesRequest,DiscardBlueprintChangesResponse> discardBlueprintChangesSettings()

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

Returns
Type	Description
`UnaryCallSettings<DiscardBlueprintChangesRequest,DiscardBlueprintChangesResponse>`

discardDeploymentChangesSettings()

public UnaryCallSettings<DiscardDeploymentChangesRequest,DiscardDeploymentChangesResponse> discardDeploymentChangesSettings()

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

Returns
Type	Description
`UnaryCallSettings<DiscardDeploymentChangesRequest,DiscardDeploymentChangesResponse>`

getBlueprintSettings()

public UnaryCallSettings<GetBlueprintRequest,Blueprint> getBlueprintSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetBlueprintRequest,Blueprint>`

getDeploymentSettings()

public UnaryCallSettings<GetDeploymentRequest,Deployment> getDeploymentSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetDeploymentRequest,Deployment>`

getEdgeSlmSettings()

public UnaryCallSettings<GetEdgeSlmRequest,EdgeSlm> getEdgeSlmSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetEdgeSlmRequest,EdgeSlm>`

getHydratedDeploymentSettings()

public UnaryCallSettings<GetHydratedDeploymentRequest,HydratedDeployment> getHydratedDeploymentSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetHydratedDeploymentRequest,HydratedDeployment>`

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>`

getOrchestrationClusterSettings()

public UnaryCallSettings<GetOrchestrationClusterRequest,OrchestrationCluster> getOrchestrationClusterSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetOrchestrationClusterRequest,OrchestrationCluster>`

getPublicBlueprintSettings()

public UnaryCallSettings<GetPublicBlueprintRequest,PublicBlueprint> getPublicBlueprintSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetPublicBlueprintRequest,PublicBlueprint>`

listBlueprintRevisionsSettings()

public PagedCallSettings<ListBlueprintRevisionsRequest,ListBlueprintRevisionsResponse,TelcoAutomationClient.ListBlueprintRevisionsPagedResponse> listBlueprintRevisionsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListBlueprintRevisionsRequest,ListBlueprintRevisionsResponse,ListBlueprintRevisionsPagedResponse>`

listBlueprintsSettings()

public PagedCallSettings<ListBlueprintsRequest,ListBlueprintsResponse,TelcoAutomationClient.ListBlueprintsPagedResponse> listBlueprintsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListBlueprintsRequest,ListBlueprintsResponse,ListBlueprintsPagedResponse>`

listDeploymentRevisionsSettings()

public PagedCallSettings<ListDeploymentRevisionsRequest,ListDeploymentRevisionsResponse,TelcoAutomationClient.ListDeploymentRevisionsPagedResponse> listDeploymentRevisionsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListDeploymentRevisionsRequest,ListDeploymentRevisionsResponse,ListDeploymentRevisionsPagedResponse>`

listDeploymentsSettings()

public PagedCallSettings<ListDeploymentsRequest,ListDeploymentsResponse,TelcoAutomationClient.ListDeploymentsPagedResponse> listDeploymentsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListDeploymentsRequest,ListDeploymentsResponse,ListDeploymentsPagedResponse>`

listEdgeSlmsSettings()

public PagedCallSettings<ListEdgeSlmsRequest,ListEdgeSlmsResponse,TelcoAutomationClient.ListEdgeSlmsPagedResponse> listEdgeSlmsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListEdgeSlmsRequest,ListEdgeSlmsResponse,ListEdgeSlmsPagedResponse>`

listHydratedDeploymentsSettings()

public PagedCallSettings<ListHydratedDeploymentsRequest,ListHydratedDeploymentsResponse,TelcoAutomationClient.ListHydratedDeploymentsPagedResponse> listHydratedDeploymentsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListHydratedDeploymentsRequest,ListHydratedDeploymentsResponse,ListHydratedDeploymentsPagedResponse>`

listLocationsSettings()

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

listOrchestrationClustersSettings()

public PagedCallSettings<ListOrchestrationClustersRequest,ListOrchestrationClustersResponse,TelcoAutomationClient.ListOrchestrationClustersPagedResponse> listOrchestrationClustersSettings()

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

Returns
Type	Description
`PagedCallSettings<ListOrchestrationClustersRequest,ListOrchestrationClustersResponse,ListOrchestrationClustersPagedResponse>`

listPublicBlueprintsSettings()

public PagedCallSettings<ListPublicBlueprintsRequest,ListPublicBlueprintsResponse,TelcoAutomationClient.ListPublicBlueprintsPagedResponse> listPublicBlueprintsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListPublicBlueprintsRequest,ListPublicBlueprintsResponse,ListPublicBlueprintsPagedResponse>`

proposeBlueprintSettings()

public UnaryCallSettings<ProposeBlueprintRequest,Blueprint> proposeBlueprintSettings()

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

Returns
Type	Description
`UnaryCallSettings<ProposeBlueprintRequest,Blueprint>`

rejectBlueprintSettings()

public UnaryCallSettings<RejectBlueprintRequest,Blueprint> rejectBlueprintSettings()

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

Returns
Type	Description
`UnaryCallSettings<RejectBlueprintRequest,Blueprint>`

removeDeploymentSettings()

public UnaryCallSettings<RemoveDeploymentRequest,Empty> removeDeploymentSettings()

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

Returns
Type	Description
`UnaryCallSettings<RemoveDeploymentRequest,Empty>`

rollbackDeploymentSettings()

public UnaryCallSettings<RollbackDeploymentRequest,Deployment> rollbackDeploymentSettings()

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

Returns
Type	Description
`UnaryCallSettings<RollbackDeploymentRequest,Deployment>`

searchBlueprintRevisionsSettings()

public PagedCallSettings<SearchBlueprintRevisionsRequest,SearchBlueprintRevisionsResponse,TelcoAutomationClient.SearchBlueprintRevisionsPagedResponse> searchBlueprintRevisionsSettings()

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

Returns
Type	Description
`PagedCallSettings<SearchBlueprintRevisionsRequest,SearchBlueprintRevisionsResponse,SearchBlueprintRevisionsPagedResponse>`

searchDeploymentRevisionsSettings()

public PagedCallSettings<SearchDeploymentRevisionsRequest,SearchDeploymentRevisionsResponse,TelcoAutomationClient.SearchDeploymentRevisionsPagedResponse> searchDeploymentRevisionsSettings()

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

Returns
Type	Description
`PagedCallSettings<SearchDeploymentRevisionsRequest,SearchDeploymentRevisionsResponse,SearchDeploymentRevisionsPagedResponse>`

toBuilder()

public TelcoAutomationSettings.Builder toBuilder()

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

Returns
Type	Description
`TelcoAutomationSettings.Builder`

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateBlueprintSettings()

public UnaryCallSettings<UpdateBlueprintRequest,Blueprint> updateBlueprintSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateBlueprintRequest,Blueprint>`

updateDeploymentSettings()

public UnaryCallSettings<UpdateDeploymentRequest,Deployment> updateDeploymentSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateDeploymentRequest,Deployment>`

updateHydratedDeploymentSettings()

public UnaryCallSettings<UpdateHydratedDeploymentRequest,HydratedDeployment> updateHydratedDeploymentSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateHydratedDeploymentRequest,HydratedDeployment>`