Class CrossNetworkAutomationServiceSettings (1.61.0) 

public class CrossNetworkAutomationServiceSettings extends ClientSettings<CrossNetworkAutomationServiceSettings>

Settings class to configure an instance of CrossNetworkAutomationServiceClient.

The default instance has everything set to sensible defaults:

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


 // 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
 CrossNetworkAutomationServiceSettings.Builder crossNetworkAutomationServiceSettingsBuilder =
     CrossNetworkAutomationServiceSettings.newBuilder();
 crossNetworkAutomationServiceSettingsBuilder
     .getServiceConnectionMapSettings()
     .setRetrySettings(
         crossNetworkAutomationServiceSettingsBuilder
             .getServiceConnectionMapSettings()
             .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());
 CrossNetworkAutomationServiceSettings crossNetworkAutomationServiceSettings =
     crossNetworkAutomationServiceSettingsBuilder.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 createServiceConnectionMap:


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

Inheritance

java.lang.Object > ClientSettings > CrossNetworkAutomationServiceSettings

Static Methods

create(CrossNetworkAutomationServiceStubSettings stub)

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

Returns a new builder for this class.

Returns
Type Description
CrossNetworkAutomationServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static CrossNetworkAutomationServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
CrossNetworkAutomationServiceSettings.Builder

Constructors

CrossNetworkAutomationServiceSettings(CrossNetworkAutomationServiceSettings.Builder settingsBuilder)

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

Methods

createServiceConnectionMapOperationSettings()

public OperationCallSettings<CreateServiceConnectionMapRequest,ServiceConnectionMap,OperationMetadata> createServiceConnectionMapOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateServiceConnectionMapRequest,ServiceConnectionMap,OperationMetadata>

createServiceConnectionMapSettings()

public UnaryCallSettings<CreateServiceConnectionMapRequest,Operation> createServiceConnectionMapSettings()

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

Returns
Type Description
UnaryCallSettings<CreateServiceConnectionMapRequest,Operation>

createServiceConnectionPolicyOperationSettings()

public OperationCallSettings<CreateServiceConnectionPolicyRequest,ServiceConnectionPolicy,OperationMetadata> createServiceConnectionPolicyOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateServiceConnectionPolicyRequest,ServiceConnectionPolicy,OperationMetadata>

createServiceConnectionPolicySettings()

public UnaryCallSettings<CreateServiceConnectionPolicyRequest,Operation> createServiceConnectionPolicySettings()

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

Returns
Type Description
UnaryCallSettings<CreateServiceConnectionPolicyRequest,Operation>

createServiceConnectionTokenOperationSettings()

public OperationCallSettings<CreateServiceConnectionTokenRequest,ServiceConnectionToken,OperationMetadata> createServiceConnectionTokenOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateServiceConnectionTokenRequest,ServiceConnectionToken,OperationMetadata>

createServiceConnectionTokenSettings()

public UnaryCallSettings<CreateServiceConnectionTokenRequest,Operation> createServiceConnectionTokenSettings()

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

Returns
Type Description
UnaryCallSettings<CreateServiceConnectionTokenRequest,Operation>

deleteServiceClassOperationSettings()

public OperationCallSettings<DeleteServiceClassRequest,Empty,OperationMetadata> deleteServiceClassOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteServiceClassRequest,Empty,OperationMetadata>

deleteServiceClassSettings()

public UnaryCallSettings<DeleteServiceClassRequest,Operation> deleteServiceClassSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteServiceClassRequest,Operation>

deleteServiceConnectionMapOperationSettings()

public OperationCallSettings<DeleteServiceConnectionMapRequest,Empty,OperationMetadata> deleteServiceConnectionMapOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteServiceConnectionMapRequest,Empty,OperationMetadata>

deleteServiceConnectionMapSettings()

public UnaryCallSettings<DeleteServiceConnectionMapRequest,Operation> deleteServiceConnectionMapSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteServiceConnectionMapRequest,Operation>

deleteServiceConnectionPolicyOperationSettings()

public OperationCallSettings<DeleteServiceConnectionPolicyRequest,Empty,OperationMetadata> deleteServiceConnectionPolicyOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteServiceConnectionPolicyRequest,Empty,OperationMetadata>

deleteServiceConnectionPolicySettings()

public UnaryCallSettings<DeleteServiceConnectionPolicyRequest,Operation> deleteServiceConnectionPolicySettings()

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

Returns
Type Description
UnaryCallSettings<DeleteServiceConnectionPolicyRequest,Operation>

deleteServiceConnectionTokenOperationSettings()

public OperationCallSettings<DeleteServiceConnectionTokenRequest,Empty,OperationMetadata> deleteServiceConnectionTokenOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteServiceConnectionTokenRequest,Empty,OperationMetadata>

deleteServiceConnectionTokenSettings()

public UnaryCallSettings<DeleteServiceConnectionTokenRequest,Operation> deleteServiceConnectionTokenSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteServiceConnectionTokenRequest,Operation>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
Type Description
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

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>

getServiceClassSettings()

public UnaryCallSettings<GetServiceClassRequest,ServiceClass> getServiceClassSettings()

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

Returns
Type Description
UnaryCallSettings<GetServiceClassRequest,ServiceClass>

getServiceConnectionMapSettings()

public UnaryCallSettings<GetServiceConnectionMapRequest,ServiceConnectionMap> getServiceConnectionMapSettings()

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

Returns
Type Description
UnaryCallSettings<GetServiceConnectionMapRequest,ServiceConnectionMap>

getServiceConnectionPolicySettings()

public UnaryCallSettings<GetServiceConnectionPolicyRequest,ServiceConnectionPolicy> getServiceConnectionPolicySettings()

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

Returns
Type Description
UnaryCallSettings<GetServiceConnectionPolicyRequest,ServiceConnectionPolicy>

getServiceConnectionTokenSettings()

public UnaryCallSettings<GetServiceConnectionTokenRequest,ServiceConnectionToken> getServiceConnectionTokenSettings()

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

Returns
Type Description
UnaryCallSettings<GetServiceConnectionTokenRequest,ServiceConnectionToken>

listLocationsSettings()

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

listServiceClassesSettings()

public PagedCallSettings<ListServiceClassesRequest,ListServiceClassesResponse,CrossNetworkAutomationServiceClient.ListServiceClassesPagedResponse> listServiceClassesSettings()

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

Returns
Type Description
PagedCallSettings<ListServiceClassesRequest,ListServiceClassesResponse,ListServiceClassesPagedResponse>

listServiceConnectionMapsSettings()

public PagedCallSettings<ListServiceConnectionMapsRequest,ListServiceConnectionMapsResponse,CrossNetworkAutomationServiceClient.ListServiceConnectionMapsPagedResponse> listServiceConnectionMapsSettings()

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

Returns
Type Description
PagedCallSettings<ListServiceConnectionMapsRequest,ListServiceConnectionMapsResponse,ListServiceConnectionMapsPagedResponse>

listServiceConnectionPoliciesSettings()

public PagedCallSettings<ListServiceConnectionPoliciesRequest,ListServiceConnectionPoliciesResponse,CrossNetworkAutomationServiceClient.ListServiceConnectionPoliciesPagedResponse> listServiceConnectionPoliciesSettings()

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

Returns
Type Description
PagedCallSettings<ListServiceConnectionPoliciesRequest,ListServiceConnectionPoliciesResponse,ListServiceConnectionPoliciesPagedResponse>

listServiceConnectionTokensSettings()

public PagedCallSettings<ListServiceConnectionTokensRequest,ListServiceConnectionTokensResponse,CrossNetworkAutomationServiceClient.ListServiceConnectionTokensPagedResponse> listServiceConnectionTokensSettings()

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

Returns
Type Description
PagedCallSettings<ListServiceConnectionTokensRequest,ListServiceConnectionTokensResponse,ListServiceConnectionTokensPagedResponse>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
Type Description
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public CrossNetworkAutomationServiceSettings.Builder toBuilder()

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

Returns
Type Description
CrossNetworkAutomationServiceSettings.Builder
Overrides

updateServiceClassOperationSettings()

public OperationCallSettings<UpdateServiceClassRequest,ServiceClass,OperationMetadata> updateServiceClassOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateServiceClassRequest,ServiceClass,OperationMetadata>

updateServiceClassSettings()

public UnaryCallSettings<UpdateServiceClassRequest,Operation> updateServiceClassSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateServiceClassRequest,Operation>

updateServiceConnectionMapOperationSettings()

public OperationCallSettings<UpdateServiceConnectionMapRequest,ServiceConnectionMap,OperationMetadata> updateServiceConnectionMapOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateServiceConnectionMapRequest,ServiceConnectionMap,OperationMetadata>

updateServiceConnectionMapSettings()

public UnaryCallSettings<UpdateServiceConnectionMapRequest,Operation> updateServiceConnectionMapSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateServiceConnectionMapRequest,Operation>

updateServiceConnectionPolicyOperationSettings()

public OperationCallSettings<UpdateServiceConnectionPolicyRequest,ServiceConnectionPolicy,OperationMetadata> updateServiceConnectionPolicyOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateServiceConnectionPolicyRequest,ServiceConnectionPolicy,OperationMetadata>

updateServiceConnectionPolicySettings()

public UnaryCallSettings<UpdateServiceConnectionPolicyRequest,Operation> updateServiceConnectionPolicySettings()

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

Returns
Type Description
UnaryCallSettings<UpdateServiceConnectionPolicyRequest,Operation>