Class SecurityCenterStubSettings (2.62.0)

public class SecurityCenterStubSettings extends StubSettings<SecurityCenterStubSettings>

Settings class to configure an instance of SecurityCenterStub.

The default instance has everything set to sensible defaults:

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


 // 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
 SecurityCenterStubSettings.Builder securityCenterSettingsBuilder =
     SecurityCenterStubSettings.newBuilder();
 securityCenterSettingsBuilder
     .createSourceSettings()
     .setRetrySettings(
         securityCenterSettingsBuilder
             .createSourceSettings()
             .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());
 SecurityCenterStubSettings securityCenterSettings = securityCenterSettingsBuilder.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 runAssetDiscovery:


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

Inheritance

java.lang.Object > StubSettings > SecurityCenterStubSettings

Static Methods

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

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST 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

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 SecurityCenterStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
SecurityCenterStubSettings.Builder

newBuilder(ClientContext clientContext)

public static SecurityCenterStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
SecurityCenterStubSettings.Builder

newHttpJsonBuilder()

public static SecurityCenterStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
SecurityCenterStubSettings.Builder

Constructors

SecurityCenterStubSettings(SecurityCenterStubSettings.Builder settingsBuilder)

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

Methods

createFindingSettings()

public UnaryCallSettings<CreateFindingRequest,Finding> createFindingSettings()

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

Returns
Type Description
UnaryCallSettings<CreateFindingRequest,Finding>

createSourceSettings()

public UnaryCallSettings<CreateSourceRequest,Source> createSourceSettings()

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

Returns
Type Description
UnaryCallSettings<CreateSourceRequest,Source>

createStub()

public SecurityCenterStub createStub()
Returns
Type Description
SecurityCenterStub
Exceptions
Type Description
IOException

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>

getOrganizationSettingsSettings()

public UnaryCallSettings<GetOrganizationSettingsRequest,OrganizationSettings> getOrganizationSettingsSettings()

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

Returns
Type Description
UnaryCallSettings<GetOrganizationSettingsRequest,OrganizationSettings>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

getSourceSettings()

public UnaryCallSettings<GetSourceRequest,Source> getSourceSettings()

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

Returns
Type Description
UnaryCallSettings<GetSourceRequest,Source>

groupAssetsSettings()

public PagedCallSettings<GroupAssetsRequest,GroupAssetsResponse,SecurityCenterClient.GroupAssetsPagedResponse> groupAssetsSettings()

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

Returns
Type Description
PagedCallSettings<GroupAssetsRequest,GroupAssetsResponse,GroupAssetsPagedResponse>

groupFindingsSettings()

public PagedCallSettings<GroupFindingsRequest,GroupFindingsResponse,SecurityCenterClient.GroupFindingsPagedResponse> groupFindingsSettings()

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

Returns
Type Description
PagedCallSettings<GroupFindingsRequest,GroupFindingsResponse,GroupFindingsPagedResponse>

listAssetsSettings()

public PagedCallSettings<ListAssetsRequest,ListAssetsResponse,SecurityCenterClient.ListAssetsPagedResponse> listAssetsSettings()

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

Returns
Type Description
PagedCallSettings<ListAssetsRequest,ListAssetsResponse,ListAssetsPagedResponse>

listFindingsSettings()

public PagedCallSettings<ListFindingsRequest,ListFindingsResponse,SecurityCenterClient.ListFindingsPagedResponse> listFindingsSettings()

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

Returns
Type Description
PagedCallSettings<ListFindingsRequest,ListFindingsResponse,ListFindingsPagedResponse>

listSourcesSettings()

public PagedCallSettings<ListSourcesRequest,ListSourcesResponse,SecurityCenterClient.ListSourcesPagedResponse> listSourcesSettings()

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

Returns
Type Description
PagedCallSettings<ListSourcesRequest,ListSourcesResponse,ListSourcesPagedResponse>

runAssetDiscoveryOperationSettings()

public OperationCallSettings<RunAssetDiscoveryRequest,Empty,Empty> runAssetDiscoveryOperationSettings()

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

Returns
Type Description
OperationCallSettings<RunAssetDiscoveryRequest,Empty,Empty>

runAssetDiscoverySettings()

public UnaryCallSettings<RunAssetDiscoveryRequest,Operation> runAssetDiscoverySettings()

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

Returns
Type Description
UnaryCallSettings<RunAssetDiscoveryRequest,Operation>

setFindingStateSettings()

public UnaryCallSettings<SetFindingStateRequest,Finding> setFindingStateSettings()

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

Returns
Type Description
UnaryCallSettings<SetFindingStateRequest,Finding>

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

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

Returns
Type Description
SecurityCenterStubSettings.Builder
Overrides

updateFindingSettings()

public UnaryCallSettings<UpdateFindingRequest,Finding> updateFindingSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateFindingRequest,Finding>

updateOrganizationSettingsSettings()

public UnaryCallSettings<UpdateOrganizationSettingsRequest,OrganizationSettings> updateOrganizationSettingsSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateOrganizationSettingsRequest,OrganizationSettings>

updateSecurityMarksSettings()

public UnaryCallSettings<UpdateSecurityMarksRequest,SecurityMarks> updateSecurityMarksSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateSecurityMarksRequest,SecurityMarks>

updateSourceSettings()

public UnaryCallSettings<UpdateSourceRequest,Source> updateSourceSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateSourceRequest,Source>