public class OrganizationSecurityProfileGroupServiceSettings extends ClientSettings<OrganizationSecurityProfileGroupServiceSettings>Settings class to configure an instance of OrganizationSecurityProfileGroupServiceClient.
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 getSecurityProfileGroup:
// 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
OrganizationSecurityProfileGroupServiceSettings.Builder
organizationSecurityProfileGroupServiceSettingsBuilder =
OrganizationSecurityProfileGroupServiceSettings.newBuilder();
organizationSecurityProfileGroupServiceSettingsBuilder
.getSecurityProfileGroupSettings()
.setRetrySettings(
organizationSecurityProfileGroupServiceSettingsBuilder
.getSecurityProfileGroupSettings()
.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());
OrganizationSecurityProfileGroupServiceSettings
organizationSecurityProfileGroupServiceSettings =
organizationSecurityProfileGroupServiceSettingsBuilder.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 createSecurityProfileGroup:
// 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
OrganizationSecurityProfileGroupServiceSettings.Builder
organizationSecurityProfileGroupServiceSettingsBuilder =
OrganizationSecurityProfileGroupServiceSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
organizationSecurityProfileGroupServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
Static Methods
create(OrganizationSecurityProfileGroupServiceStubSettings stub)
public static final OrganizationSecurityProfileGroupServiceSettings create(OrganizationSecurityProfileGroupServiceStubSettings stub)| Parameter | |
|---|---|
| Name | Description |
stub |
OrganizationSecurityProfileGroupServiceStubSettings |
| Returns | |
|---|---|
| Type | Description |
OrganizationSecurityProfileGroupServiceSettings |
|
| 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 OrganizationSecurityProfileGroupServiceSettings.Builder newBuilder()Returns a new builder for this class.
| Returns | |
|---|---|
| Type | Description |
OrganizationSecurityProfileGroupServiceSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static OrganizationSecurityProfileGroupServiceSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
OrganizationSecurityProfileGroupServiceSettings.Builder |
|
Constructors
OrganizationSecurityProfileGroupServiceSettings(OrganizationSecurityProfileGroupServiceSettings.Builder settingsBuilder)
protected OrganizationSecurityProfileGroupServiceSettings(OrganizationSecurityProfileGroupServiceSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
OrganizationSecurityProfileGroupServiceSettings.Builder |
Methods
createSecurityProfileGroupOperationSettings()
public OperationCallSettings<CreateSecurityProfileGroupRequest,SecurityProfileGroup,OperationMetadata> createSecurityProfileGroupOperationSettings()Returns the object with the settings used for calls to createSecurityProfileGroup.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateSecurityProfileGroupRequest,SecurityProfileGroup,OperationMetadata> |
|
createSecurityProfileGroupSettings()
public UnaryCallSettings<CreateSecurityProfileGroupRequest,Operation> createSecurityProfileGroupSettings()Returns the object with the settings used for calls to createSecurityProfileGroup.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateSecurityProfileGroupRequest,Operation> |
|
createSecurityProfileOperationSettings()
public OperationCallSettings<CreateSecurityProfileRequest,SecurityProfile,OperationMetadata> createSecurityProfileOperationSettings()Returns the object with the settings used for calls to createSecurityProfile.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateSecurityProfileRequest,SecurityProfile,OperationMetadata> |
|
createSecurityProfileSettings()
public UnaryCallSettings<CreateSecurityProfileRequest,Operation> createSecurityProfileSettings()Returns the object with the settings used for calls to createSecurityProfile.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateSecurityProfileRequest,Operation> |
|
deleteSecurityProfileGroupOperationSettings()
public OperationCallSettings<DeleteSecurityProfileGroupRequest,Empty,OperationMetadata> deleteSecurityProfileGroupOperationSettings()Returns the object with the settings used for calls to deleteSecurityProfileGroup.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteSecurityProfileGroupRequest,Empty,OperationMetadata> |
|
deleteSecurityProfileGroupSettings()
public UnaryCallSettings<DeleteSecurityProfileGroupRequest,Operation> deleteSecurityProfileGroupSettings()Returns the object with the settings used for calls to deleteSecurityProfileGroup.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteSecurityProfileGroupRequest,Operation> |
|
deleteSecurityProfileOperationSettings()
public OperationCallSettings<DeleteSecurityProfileRequest,Empty,OperationMetadata> deleteSecurityProfileOperationSettings()Returns the object with the settings used for calls to deleteSecurityProfile.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteSecurityProfileRequest,Empty,OperationMetadata> |
|
deleteSecurityProfileSettings()
public UnaryCallSettings<DeleteSecurityProfileRequest,Operation> deleteSecurityProfileSettings()Returns the object with the settings used for calls to deleteSecurityProfile.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteSecurityProfileRequest,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> |
|
getSecurityProfileGroupSettings()
public UnaryCallSettings<GetSecurityProfileGroupRequest,SecurityProfileGroup> getSecurityProfileGroupSettings()Returns the object with the settings used for calls to getSecurityProfileGroup.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetSecurityProfileGroupRequest,SecurityProfileGroup> |
|
getSecurityProfileSettings()
public UnaryCallSettings<GetSecurityProfileRequest,SecurityProfile> getSecurityProfileSettings()Returns the object with the settings used for calls to getSecurityProfile.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetSecurityProfileRequest,SecurityProfile> |
|
listLocationsSettings()
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,OrganizationSecurityProfileGroupServiceClient.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> |
|
listSecurityProfileGroupsSettings()
public PagedCallSettings<ListSecurityProfileGroupsRequest,ListSecurityProfileGroupsResponse,OrganizationSecurityProfileGroupServiceClient.ListSecurityProfileGroupsPagedResponse> listSecurityProfileGroupsSettings()Returns the object with the settings used for calls to listSecurityProfileGroups.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListSecurityProfileGroupsRequest,ListSecurityProfileGroupsResponse,ListSecurityProfileGroupsPagedResponse> |
|
listSecurityProfilesSettings()
public PagedCallSettings<ListSecurityProfilesRequest,ListSecurityProfilesResponse,OrganizationSecurityProfileGroupServiceClient.ListSecurityProfilesPagedResponse> listSecurityProfilesSettings()Returns the object with the settings used for calls to listSecurityProfiles.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListSecurityProfilesRequest,ListSecurityProfilesResponse,ListSecurityProfilesPagedResponse> |
|
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 OrganizationSecurityProfileGroupServiceSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
OrganizationSecurityProfileGroupServiceSettings.Builder |
|
updateSecurityProfileGroupOperationSettings()
public OperationCallSettings<UpdateSecurityProfileGroupRequest,SecurityProfileGroup,OperationMetadata> updateSecurityProfileGroupOperationSettings()Returns the object with the settings used for calls to updateSecurityProfileGroup.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateSecurityProfileGroupRequest,SecurityProfileGroup,OperationMetadata> |
|
updateSecurityProfileGroupSettings()
public UnaryCallSettings<UpdateSecurityProfileGroupRequest,Operation> updateSecurityProfileGroupSettings()Returns the object with the settings used for calls to updateSecurityProfileGroup.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateSecurityProfileGroupRequest,Operation> |
|
updateSecurityProfileOperationSettings()
public OperationCallSettings<UpdateSecurityProfileRequest,SecurityProfile,OperationMetadata> updateSecurityProfileOperationSettings()Returns the object with the settings used for calls to updateSecurityProfile.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateSecurityProfileRequest,SecurityProfile,OperationMetadata> |
|
updateSecurityProfileSettings()
public UnaryCallSettings<UpdateSecurityProfileRequest,Operation> updateSecurityProfileSettings()Returns the object with the settings used for calls to updateSecurityProfile.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateSecurityProfileRequest,Operation> |
|