Class OrganizationAddressGroupServiceSettings (0.77.0) 

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 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 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();

Inheritance

java.lang.Object > ClientSettings > OrganizationAddressGroupServiceSettings

Static Methods

create(OrganizationAddressGroupServiceStubSettings stub)

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

Returns a new builder for this class.

Returns
Type Description
OrganizationAddressGroupServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static OrganizationAddressGroupServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
OrganizationAddressGroupServiceSettings.Builder

Constructors

OrganizationAddressGroupServiceSettings(OrganizationAddressGroupServiceSettings.Builder settingsBuilder)

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

Methods

addAddressGroupItemsOperationSettings()

public OperationCallSettings<AddAddressGroupItemsRequest,AddressGroup,OperationMetadata> addAddressGroupItemsOperationSettings()

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

Returns
Type Description
OperationCallSettings<AddAddressGroupItemsRequest,AddressGroup,OperationMetadata>

addAddressGroupItemsSettings()

public UnaryCallSettings<AddAddressGroupItemsRequest,Operation> addAddressGroupItemsSettings()

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

Returns
Type Description
UnaryCallSettings<AddAddressGroupItemsRequest,Operation>

cloneAddressGroupItemsOperationSettings()

public OperationCallSettings<CloneAddressGroupItemsRequest,AddressGroup,OperationMetadata> cloneAddressGroupItemsOperationSettings()

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

Returns
Type Description
OperationCallSettings<CloneAddressGroupItemsRequest,AddressGroup,OperationMetadata>

cloneAddressGroupItemsSettings()

public UnaryCallSettings<CloneAddressGroupItemsRequest,Operation> cloneAddressGroupItemsSettings()

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

Returns
Type Description
UnaryCallSettings<CloneAddressGroupItemsRequest,Operation>

createAddressGroupOperationSettings()

public OperationCallSettings<CreateAddressGroupRequest,AddressGroup,OperationMetadata> createAddressGroupOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateAddressGroupRequest,AddressGroup,OperationMetadata>

createAddressGroupSettings()

public UnaryCallSettings<CreateAddressGroupRequest,Operation> createAddressGroupSettings()

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

Returns
Type Description
UnaryCallSettings<CreateAddressGroupRequest,Operation>

deleteAddressGroupOperationSettings()

public OperationCallSettings<DeleteAddressGroupRequest,Empty,OperationMetadata> deleteAddressGroupOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteAddressGroupRequest,Empty,OperationMetadata>

deleteAddressGroupSettings()

public UnaryCallSettings<DeleteAddressGroupRequest,Operation> deleteAddressGroupSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteAddressGroupRequest,Operation>

getAddressGroupSettings()

public UnaryCallSettings<GetAddressGroupRequest,AddressGroup> getAddressGroupSettings()

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

Returns
Type Description
UnaryCallSettings<GetAddressGroupRequest,AddressGroup>

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>

listAddressGroupReferencesSettings()

public PagedCallSettings<ListAddressGroupReferencesRequest,ListAddressGroupReferencesResponse,OrganizationAddressGroupServiceClient.ListAddressGroupReferencesPagedResponse> listAddressGroupReferencesSettings()

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

Returns
Type Description
PagedCallSettings<ListAddressGroupReferencesRequest,ListAddressGroupReferencesResponse,ListAddressGroupReferencesPagedResponse>

listAddressGroupsSettings()

public PagedCallSettings<ListAddressGroupsRequest,ListAddressGroupsResponse,OrganizationAddressGroupServiceClient.ListAddressGroupsPagedResponse> listAddressGroupsSettings()

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

Returns
Type Description
PagedCallSettings<ListAddressGroupsRequest,ListAddressGroupsResponse,ListAddressGroupsPagedResponse>

listLocationsSettings()

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

removeAddressGroupItemsOperationSettings()

public OperationCallSettings<RemoveAddressGroupItemsRequest,AddressGroup,OperationMetadata> removeAddressGroupItemsOperationSettings()

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

Returns
Type Description
OperationCallSettings<RemoveAddressGroupItemsRequest,AddressGroup,OperationMetadata>

removeAddressGroupItemsSettings()

public UnaryCallSettings<RemoveAddressGroupItemsRequest,Operation> removeAddressGroupItemsSettings()

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

Returns
Type Description
UnaryCallSettings<RemoveAddressGroupItemsRequest,Operation>

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 OrganizationAddressGroupServiceSettings.Builder toBuilder()

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

Returns
Type Description
OrganizationAddressGroupServiceSettings.Builder
Overrides

updateAddressGroupOperationSettings()

public OperationCallSettings<UpdateAddressGroupRequest,AddressGroup,OperationMetadata> updateAddressGroupOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateAddressGroupRequest,AddressGroup,OperationMetadata>

updateAddressGroupSettings()

public UnaryCallSettings<UpdateAddressGroupRequest,Operation> updateAddressGroupSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateAddressGroupRequest,Operation>