Class OrganizationAddressGroupServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<OrganizationAddressGroupServiceSettings>
com.google.cloud.networksecurity.v1.OrganizationAddressGroupServiceSettings
@Generated("by gapic-generator-java")
public class OrganizationAddressGroupServiceSettings
extends ClientSettings<OrganizationAddressGroupServiceSettings>
Settings class to configure an instance of
OrganizationAddressGroupServiceClient.
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 getAddressGroup:
// 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
OrganizationAddressGroupServiceSettings.Builder organizationAddressGroupServiceSettingsBuilder =
OrganizationAddressGroupServiceSettings.newBuilder();
organizationAddressGroupServiceSettingsBuilder
.getAddressGroupSettings()
.setRetrySettings(
organizationAddressGroupServiceSettingsBuilder
.getAddressGroupSettings()
.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());
OrganizationAddressGroupServiceSettings organizationAddressGroupServiceSettings =
organizationAddressGroupServiceSettingsBuilder.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 createAddressGroup:
// 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
OrganizationAddressGroupServiceSettings.Builder organizationAddressGroupServiceSettingsBuilder =
OrganizationAddressGroupServiceSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
organizationAddressGroupServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for OrganizationAddressGroupServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedOrganizationAddressGroupServiceSettings(OrganizationAddressGroupServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to addAddressGroupItems.Returns the object with the settings used for calls to addAddressGroupItems.Returns the object with the settings used for calls to cloneAddressGroupItems.Returns the object with the settings used for calls to cloneAddressGroupItems.static final OrganizationAddressGroupServiceSettingsReturns the object with the settings used for calls to createAddressGroup.Returns the object with the settings used for calls to createAddressGroup.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<DeleteAddressGroupRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteAddressGroup.Returns the object with the settings used for calls to deleteAddressGroup.Returns the object with the settings used for calls to getAddressGroup.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.PagedCallSettings<ListAddressGroupReferencesRequest,ListAddressGroupReferencesResponse, OrganizationAddressGroupServiceClient.ListAddressGroupReferencesPagedResponse> Returns the object with the settings used for calls to listAddressGroupReferences.PagedCallSettings<ListAddressGroupsRequest,ListAddressGroupsResponse, OrganizationAddressGroupServiceClient.ListAddressGroupsPagedResponse> Returns the object with the settings used for calls to listAddressGroups.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, OrganizationAddressGroupServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.Returns a new builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns the object with the settings used for calls to removeAddressGroupItems.Returns the object with the settings used for calls to removeAddressGroupItems.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.Returns the object with the settings used for calls to updateAddressGroup.Returns the object with the settings used for calls to updateAddressGroup.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
-
OrganizationAddressGroupServiceSettings
protected OrganizationAddressGroupServiceSettings(OrganizationAddressGroupServiceSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listAddressGroupsSettings
public PagedCallSettings<ListAddressGroupsRequest,ListAddressGroupsResponse, listAddressGroupsSettings()OrganizationAddressGroupServiceClient.ListAddressGroupsPagedResponse> Returns the object with the settings used for calls to listAddressGroups. -
getAddressGroupSettings
Returns the object with the settings used for calls to getAddressGroup. -
createAddressGroupSettings
Returns the object with the settings used for calls to createAddressGroup. -
createAddressGroupOperationSettings
public OperationCallSettings<CreateAddressGroupRequest,AddressGroup, createAddressGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createAddressGroup. -
updateAddressGroupSettings
Returns the object with the settings used for calls to updateAddressGroup. -
updateAddressGroupOperationSettings
public OperationCallSettings<UpdateAddressGroupRequest,AddressGroup, updateAddressGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateAddressGroup. -
addAddressGroupItemsSettings
Returns the object with the settings used for calls to addAddressGroupItems. -
addAddressGroupItemsOperationSettings
public OperationCallSettings<AddAddressGroupItemsRequest,AddressGroup, addAddressGroupItemsOperationSettings()OperationMetadata> Returns the object with the settings used for calls to addAddressGroupItems. -
removeAddressGroupItemsSettings
public UnaryCallSettings<RemoveAddressGroupItemsRequest,Operation> removeAddressGroupItemsSettings()Returns the object with the settings used for calls to removeAddressGroupItems. -
removeAddressGroupItemsOperationSettings
public OperationCallSettings<RemoveAddressGroupItemsRequest,AddressGroup, removeAddressGroupItemsOperationSettings()OperationMetadata> Returns the object with the settings used for calls to removeAddressGroupItems. -
cloneAddressGroupItemsSettings
Returns the object with the settings used for calls to cloneAddressGroupItems. -
cloneAddressGroupItemsOperationSettings
public OperationCallSettings<CloneAddressGroupItemsRequest,AddressGroup, cloneAddressGroupItemsOperationSettings()OperationMetadata> Returns the object with the settings used for calls to cloneAddressGroupItems. -
deleteAddressGroupSettings
Returns the object with the settings used for calls to deleteAddressGroup. -
deleteAddressGroupOperationSettings
public OperationCallSettings<DeleteAddressGroupRequest,com.google.protobuf.Empty, deleteAddressGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteAddressGroup. -
listAddressGroupReferencesSettings
public PagedCallSettings<ListAddressGroupReferencesRequest,ListAddressGroupReferencesResponse, listAddressGroupReferencesSettings()OrganizationAddressGroupServiceClient.ListAddressGroupReferencesPagedResponse> Returns the object with the settings used for calls to listAddressGroupReferences. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()OrganizationAddressGroupServiceClient.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
public static final OrganizationAddressGroupServiceSettings create(OrganizationAddressGroupServiceStubSettings stub) throws IOException - 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
public static OrganizationAddressGroupServiceSettings.Builder newBuilder(ClientContext clientContext) Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<OrganizationAddressGroupServiceSettings>
-