Class MirroringSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<MirroringSettings>
com.google.cloud.networksecurity.v1.MirroringSettings
@Generated("by gapic-generator-java")
public class MirroringSettings
extends ClientSettings<MirroringSettings>
Settings class to configure an instance of
MirroringClient.
The default instance has everything set to sensible defaults:
- The default service address (networksecurity.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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of getMirroringEndpointGroup:
// 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
MirroringSettings.Builder mirroringSettingsBuilder = MirroringSettings.newBuilder();
mirroringSettingsBuilder
.getMirroringEndpointGroupSettings()
.setRetrySettings(
mirroringSettingsBuilder
.getMirroringEndpointGroupSettings()
.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());
MirroringSettings mirroringSettings = mirroringSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) 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 createMirroringEndpointGroup:
// 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
MirroringSettings.Builder mirroringSettingsBuilder = MirroringSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
mirroringSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for MirroringSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedMirroringSettings(MirroringSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final MirroringSettingscreate(MirroringStubSettings stub) OperationCallSettings<CreateMirroringDeploymentGroupRequest,MirroringDeploymentGroup, OperationMetadata> Returns the object with the settings used for calls to createMirroringDeploymentGroup.Returns the object with the settings used for calls to createMirroringDeploymentGroup.Returns the object with the settings used for calls to createMirroringDeployment.Returns the object with the settings used for calls to createMirroringDeployment.OperationCallSettings<CreateMirroringEndpointGroupAssociationRequest,MirroringEndpointGroupAssociation, OperationMetadata> Returns the object with the settings used for calls to createMirroringEndpointGroupAssociation.Returns the object with the settings used for calls to createMirroringEndpointGroupAssociation.Returns the object with the settings used for calls to createMirroringEndpointGroup.Returns the object with the settings used for calls to createMirroringEndpointGroup.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteMirroringDeploymentGroupRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteMirroringDeploymentGroup.Returns the object with the settings used for calls to deleteMirroringDeploymentGroup.OperationCallSettings<DeleteMirroringDeploymentRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteMirroringDeployment.Returns the object with the settings used for calls to deleteMirroringDeployment.OperationCallSettings<DeleteMirroringEndpointGroupAssociationRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteMirroringEndpointGroupAssociation.Returns the object with the settings used for calls to deleteMirroringEndpointGroupAssociation.OperationCallSettings<DeleteMirroringEndpointGroupRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteMirroringEndpointGroup.Returns the object with the settings used for calls to deleteMirroringEndpointGroup.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getIamPolicy.Returns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getMirroringDeploymentGroup.Returns the object with the settings used for calls to getMirroringDeployment.Returns the object with the settings used for calls to getMirroringEndpointGroupAssociation.Returns the object with the settings used for calls to getMirroringEndpointGroup.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, MirroringClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListMirroringDeploymentGroupsRequest,ListMirroringDeploymentGroupsResponse, MirroringClient.ListMirroringDeploymentGroupsPagedResponse> Returns the object with the settings used for calls to listMirroringDeploymentGroups.PagedCallSettings<ListMirroringDeploymentsRequest,ListMirroringDeploymentsResponse, MirroringClient.ListMirroringDeploymentsPagedResponse> Returns the object with the settings used for calls to listMirroringDeployments.PagedCallSettings<ListMirroringEndpointGroupAssociationsRequest,ListMirroringEndpointGroupAssociationsResponse, MirroringClient.ListMirroringEndpointGroupAssociationsPagedResponse> Returns the object with the settings used for calls to listMirroringEndpointGroupAssociations.PagedCallSettings<ListMirroringEndpointGroupsRequest,ListMirroringEndpointGroupsResponse, MirroringClient.ListMirroringEndpointGroupsPagedResponse> Returns the object with the settings used for calls to listMirroringEndpointGroups.static MirroringSettings.BuilderReturns a new builder for this class.static MirroringSettings.BuildernewBuilder(ClientContext clientContext) Returns a new builder for this class.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.OperationCallSettings<UpdateMirroringDeploymentGroupRequest,MirroringDeploymentGroup, OperationMetadata> Returns the object with the settings used for calls to updateMirroringDeploymentGroup.Returns the object with the settings used for calls to updateMirroringDeploymentGroup.Returns the object with the settings used for calls to updateMirroringDeployment.Returns the object with the settings used for calls to updateMirroringDeployment.OperationCallSettings<UpdateMirroringEndpointGroupAssociationRequest,MirroringEndpointGroupAssociation, OperationMetadata> Returns the object with the settings used for calls to updateMirroringEndpointGroupAssociation.Returns the object with the settings used for calls to updateMirroringEndpointGroupAssociation.Returns the object with the settings used for calls to updateMirroringEndpointGroup.Returns the object with the settings used for calls to updateMirroringEndpointGroup.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
MirroringSettings
- Throws:
IOException
-
-
Method Details
-
listMirroringEndpointGroupsSettings
public PagedCallSettings<ListMirroringEndpointGroupsRequest,ListMirroringEndpointGroupsResponse, listMirroringEndpointGroupsSettings()MirroringClient.ListMirroringEndpointGroupsPagedResponse> Returns the object with the settings used for calls to listMirroringEndpointGroups. -
getMirroringEndpointGroupSettings
public UnaryCallSettings<GetMirroringEndpointGroupRequest,MirroringEndpointGroup> getMirroringEndpointGroupSettings()Returns the object with the settings used for calls to getMirroringEndpointGroup. -
createMirroringEndpointGroupSettings
public UnaryCallSettings<CreateMirroringEndpointGroupRequest,Operation> createMirroringEndpointGroupSettings()Returns the object with the settings used for calls to createMirroringEndpointGroup. -
createMirroringEndpointGroupOperationSettings
public OperationCallSettings<CreateMirroringEndpointGroupRequest,MirroringEndpointGroup, createMirroringEndpointGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createMirroringEndpointGroup. -
updateMirroringEndpointGroupSettings
public UnaryCallSettings<UpdateMirroringEndpointGroupRequest,Operation> updateMirroringEndpointGroupSettings()Returns the object with the settings used for calls to updateMirroringEndpointGroup. -
updateMirroringEndpointGroupOperationSettings
public OperationCallSettings<UpdateMirroringEndpointGroupRequest,MirroringEndpointGroup, updateMirroringEndpointGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateMirroringEndpointGroup. -
deleteMirroringEndpointGroupSettings
public UnaryCallSettings<DeleteMirroringEndpointGroupRequest,Operation> deleteMirroringEndpointGroupSettings()Returns the object with the settings used for calls to deleteMirroringEndpointGroup. -
deleteMirroringEndpointGroupOperationSettings
public OperationCallSettings<DeleteMirroringEndpointGroupRequest,com.google.protobuf.Empty, deleteMirroringEndpointGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteMirroringEndpointGroup. -
listMirroringEndpointGroupAssociationsSettings
public PagedCallSettings<ListMirroringEndpointGroupAssociationsRequest,ListMirroringEndpointGroupAssociationsResponse, listMirroringEndpointGroupAssociationsSettings()MirroringClient.ListMirroringEndpointGroupAssociationsPagedResponse> Returns the object with the settings used for calls to listMirroringEndpointGroupAssociations. -
getMirroringEndpointGroupAssociationSettings
public UnaryCallSettings<GetMirroringEndpointGroupAssociationRequest,MirroringEndpointGroupAssociation> getMirroringEndpointGroupAssociationSettings()Returns the object with the settings used for calls to getMirroringEndpointGroupAssociation. -
createMirroringEndpointGroupAssociationSettings
public UnaryCallSettings<CreateMirroringEndpointGroupAssociationRequest,Operation> createMirroringEndpointGroupAssociationSettings()Returns the object with the settings used for calls to createMirroringEndpointGroupAssociation. -
createMirroringEndpointGroupAssociationOperationSettings
public OperationCallSettings<CreateMirroringEndpointGroupAssociationRequest,MirroringEndpointGroupAssociation, createMirroringEndpointGroupAssociationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createMirroringEndpointGroupAssociation. -
updateMirroringEndpointGroupAssociationSettings
public UnaryCallSettings<UpdateMirroringEndpointGroupAssociationRequest,Operation> updateMirroringEndpointGroupAssociationSettings()Returns the object with the settings used for calls to updateMirroringEndpointGroupAssociation. -
updateMirroringEndpointGroupAssociationOperationSettings
public OperationCallSettings<UpdateMirroringEndpointGroupAssociationRequest,MirroringEndpointGroupAssociation, updateMirroringEndpointGroupAssociationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateMirroringEndpointGroupAssociation. -
deleteMirroringEndpointGroupAssociationSettings
public UnaryCallSettings<DeleteMirroringEndpointGroupAssociationRequest,Operation> deleteMirroringEndpointGroupAssociationSettings()Returns the object with the settings used for calls to deleteMirroringEndpointGroupAssociation. -
deleteMirroringEndpointGroupAssociationOperationSettings
public OperationCallSettings<DeleteMirroringEndpointGroupAssociationRequest,com.google.protobuf.Empty, deleteMirroringEndpointGroupAssociationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteMirroringEndpointGroupAssociation. -
listMirroringDeploymentGroupsSettings
public PagedCallSettings<ListMirroringDeploymentGroupsRequest,ListMirroringDeploymentGroupsResponse, listMirroringDeploymentGroupsSettings()MirroringClient.ListMirroringDeploymentGroupsPagedResponse> Returns the object with the settings used for calls to listMirroringDeploymentGroups. -
getMirroringDeploymentGroupSettings
public UnaryCallSettings<GetMirroringDeploymentGroupRequest,MirroringDeploymentGroup> getMirroringDeploymentGroupSettings()Returns the object with the settings used for calls to getMirroringDeploymentGroup. -
createMirroringDeploymentGroupSettings
public UnaryCallSettings<CreateMirroringDeploymentGroupRequest,Operation> createMirroringDeploymentGroupSettings()Returns the object with the settings used for calls to createMirroringDeploymentGroup. -
createMirroringDeploymentGroupOperationSettings
public OperationCallSettings<CreateMirroringDeploymentGroupRequest,MirroringDeploymentGroup, createMirroringDeploymentGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createMirroringDeploymentGroup. -
updateMirroringDeploymentGroupSettings
public UnaryCallSettings<UpdateMirroringDeploymentGroupRequest,Operation> updateMirroringDeploymentGroupSettings()Returns the object with the settings used for calls to updateMirroringDeploymentGroup. -
updateMirroringDeploymentGroupOperationSettings
public OperationCallSettings<UpdateMirroringDeploymentGroupRequest,MirroringDeploymentGroup, updateMirroringDeploymentGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateMirroringDeploymentGroup. -
deleteMirroringDeploymentGroupSettings
public UnaryCallSettings<DeleteMirroringDeploymentGroupRequest,Operation> deleteMirroringDeploymentGroupSettings()Returns the object with the settings used for calls to deleteMirroringDeploymentGroup. -
deleteMirroringDeploymentGroupOperationSettings
public OperationCallSettings<DeleteMirroringDeploymentGroupRequest,com.google.protobuf.Empty, deleteMirroringDeploymentGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteMirroringDeploymentGroup. -
listMirroringDeploymentsSettings
public PagedCallSettings<ListMirroringDeploymentsRequest,ListMirroringDeploymentsResponse, listMirroringDeploymentsSettings()MirroringClient.ListMirroringDeploymentsPagedResponse> Returns the object with the settings used for calls to listMirroringDeployments. -
getMirroringDeploymentSettings
public UnaryCallSettings<GetMirroringDeploymentRequest,MirroringDeployment> getMirroringDeploymentSettings()Returns the object with the settings used for calls to getMirroringDeployment. -
createMirroringDeploymentSettings
public UnaryCallSettings<CreateMirroringDeploymentRequest,Operation> createMirroringDeploymentSettings()Returns the object with the settings used for calls to createMirroringDeployment. -
createMirroringDeploymentOperationSettings
public OperationCallSettings<CreateMirroringDeploymentRequest,MirroringDeployment, createMirroringDeploymentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createMirroringDeployment. -
updateMirroringDeploymentSettings
public UnaryCallSettings<UpdateMirroringDeploymentRequest,Operation> updateMirroringDeploymentSettings()Returns the object with the settings used for calls to updateMirroringDeployment. -
updateMirroringDeploymentOperationSettings
public OperationCallSettings<UpdateMirroringDeploymentRequest,MirroringDeployment, updateMirroringDeploymentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateMirroringDeployment. -
deleteMirroringDeploymentSettings
public UnaryCallSettings<DeleteMirroringDeploymentRequest,Operation> deleteMirroringDeploymentSettings()Returns the object with the settings used for calls to deleteMirroringDeployment. -
deleteMirroringDeploymentOperationSettings
public OperationCallSettings<DeleteMirroringDeploymentRequest,com.google.protobuf.Empty, deleteMirroringDeploymentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteMirroringDeployment. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()MirroringClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
create
- Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<MirroringSettings>
-