The interfaces provided are listed below, along with usage samples.
SecurityCenterClient
Service Description: V1 Beta APIs for Security Center service.
Sample for SecurityCenterClient:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SecurityCenterClient securityCenterClient = SecurityCenterClient.create()) {
OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
Source source = Source.newBuilder().build();
Source response = securityCenterClient.createSource(parent, source);
}
Classes
Asset
Security Command Center representation of a Google Cloud resource. The Asset is a Security Command Center resource that captures information about a single Google Cloud resource. All modifications to an Asset are only within the context of Security Command Center and don't affect the referenced Google Cloud resource.
Protobuf type google.cloud.securitycenter.v1beta1.Asset
Asset.Builder
Security Command Center representation of a Google Cloud resource. The Asset is a Security Command Center resource that captures information about a single Google Cloud resource. All modifications to an Asset are only within the context of Security Command Center and don't affect the referenced Google Cloud resource.
Protobuf type google.cloud.securitycenter.v1beta1.Asset
Asset.SecurityCenterProperties
Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user.
Protobuf type google.cloud.securitycenter.v1beta1.Asset.SecurityCenterProperties
Asset.SecurityCenterProperties.Builder
Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user.
Protobuf type google.cloud.securitycenter.v1beta1.Asset.SecurityCenterProperties
AssetOuterClass
AssetSecurityMarksName (deprecated)
Deprecated. This resource name class will be removed in the next major version.
AUTO-GENERATED DOCUMENTATION AND CLASS
AssetSecurityMarksName.Builder
Builder for AssetSecurityMarksName.
CreateFindingRequest
Request message for creating a finding.
Protobuf type google.cloud.securitycenter.v1beta1.CreateFindingRequest
CreateFindingRequest.Builder
Request message for creating a finding.
Protobuf type google.cloud.securitycenter.v1beta1.CreateFindingRequest
CreateSourceRequest
Request message for creating a source.
Protobuf type google.cloud.securitycenter.v1beta1.CreateSourceRequest
CreateSourceRequest.Builder
Request message for creating a source.
Protobuf type google.cloud.securitycenter.v1beta1.CreateSourceRequest
Finding
Security Command Center finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding.
Protobuf type google.cloud.securitycenter.v1beta1.Finding
Finding.Builder
Security Command Center finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding.
Protobuf type google.cloud.securitycenter.v1beta1.Finding
FindingName
FindingName.Builder
Builder for organizations/{organization}/sources/{source}/findings/{finding}.
FindingOuterClass
FindingSecurityMarksName (deprecated)
Deprecated. This resource name class will be removed in the next major version.
AUTO-GENERATED DOCUMENTATION AND CLASS
FindingSecurityMarksName.Builder
Builder for FindingSecurityMarksName.
GetOrganizationSettingsRequest
Request message for getting organization settings.
Protobuf type google.cloud.securitycenter.v1beta1.GetOrganizationSettingsRequest
GetOrganizationSettingsRequest.Builder
Request message for getting organization settings.
Protobuf type google.cloud.securitycenter.v1beta1.GetOrganizationSettingsRequest
GetSourceRequest
Request message for getting a source.
Protobuf type google.cloud.securitycenter.v1beta1.GetSourceRequest
GetSourceRequest.Builder
Request message for getting a source.
Protobuf type google.cloud.securitycenter.v1beta1.GetSourceRequest
GroupAssetsRequest
Request message for grouping by assets.
Protobuf type google.cloud.securitycenter.v1beta1.GroupAssetsRequest
GroupAssetsRequest.Builder
Request message for grouping by assets.
Protobuf type google.cloud.securitycenter.v1beta1.GroupAssetsRequest
GroupAssetsResponse
Response message for grouping by assets.
Protobuf type google.cloud.securitycenter.v1beta1.GroupAssetsResponse
GroupAssetsResponse.Builder
Response message for grouping by assets.
Protobuf type google.cloud.securitycenter.v1beta1.GroupAssetsResponse
GroupFindingsRequest
Request message for grouping by findings.
Protobuf type google.cloud.securitycenter.v1beta1.GroupFindingsRequest
GroupFindingsRequest.Builder
Request message for grouping by findings.
Protobuf type google.cloud.securitycenter.v1beta1.GroupFindingsRequest
GroupFindingsResponse
Response message for group by findings.
Protobuf type google.cloud.securitycenter.v1beta1.GroupFindingsResponse
GroupFindingsResponse.Builder
Response message for group by findings.
Protobuf type google.cloud.securitycenter.v1beta1.GroupFindingsResponse
GroupResult
Result containing the properties and count of a groupBy request.
Protobuf type google.cloud.securitycenter.v1beta1.GroupResult
GroupResult.Builder
Result containing the properties and count of a groupBy request.
Protobuf type google.cloud.securitycenter.v1beta1.GroupResult
ListAssetsRequest
Request message for listing assets.
Protobuf type google.cloud.securitycenter.v1beta1.ListAssetsRequest
ListAssetsRequest.Builder
Request message for listing assets.
Protobuf type google.cloud.securitycenter.v1beta1.ListAssetsRequest
ListAssetsResponse
Response message for listing assets.
Protobuf type google.cloud.securitycenter.v1beta1.ListAssetsResponse
ListAssetsResponse.Builder
Response message for listing assets.
Protobuf type google.cloud.securitycenter.v1beta1.ListAssetsResponse
ListAssetsResponse.ListAssetsResult
Result containing the Asset and its State.
Protobuf type google.cloud.securitycenter.v1beta1.ListAssetsResponse.ListAssetsResult
ListAssetsResponse.ListAssetsResult.Builder
Result containing the Asset and its State.
Protobuf type google.cloud.securitycenter.v1beta1.ListAssetsResponse.ListAssetsResult
ListFindingsRequest
Request message for listing findings.
Protobuf type google.cloud.securitycenter.v1beta1.ListFindingsRequest
ListFindingsRequest.Builder
Request message for listing findings.
Protobuf type google.cloud.securitycenter.v1beta1.ListFindingsRequest
ListFindingsResponse
Response message for listing findings.
Protobuf type google.cloud.securitycenter.v1beta1.ListFindingsResponse
ListFindingsResponse.Builder
Response message for listing findings.
Protobuf type google.cloud.securitycenter.v1beta1.ListFindingsResponse
ListSourcesRequest
Request message for listing sources.
Protobuf type google.cloud.securitycenter.v1beta1.ListSourcesRequest
ListSourcesRequest.Builder
Request message for listing sources.
Protobuf type google.cloud.securitycenter.v1beta1.ListSourcesRequest
ListSourcesResponse
Response message for listing sources.
Protobuf type google.cloud.securitycenter.v1beta1.ListSourcesResponse
ListSourcesResponse.Builder
Response message for listing sources.
Protobuf type google.cloud.securitycenter.v1beta1.ListSourcesResponse
OrganizationName
OrganizationName.Builder
Builder for organizations/{organization}.
OrganizationSettings
User specified settings that are attached to the Security Command Center organization.
Protobuf type google.cloud.securitycenter.v1beta1.OrganizationSettings
OrganizationSettings.AssetDiscoveryConfig
The configuration used for Asset Discovery runs.
Protobuf type
google.cloud.securitycenter.v1beta1.OrganizationSettings.AssetDiscoveryConfig
OrganizationSettings.AssetDiscoveryConfig.Builder
The configuration used for Asset Discovery runs.
Protobuf type
google.cloud.securitycenter.v1beta1.OrganizationSettings.AssetDiscoveryConfig
OrganizationSettings.Builder
User specified settings that are attached to the Security Command Center organization.
Protobuf type google.cloud.securitycenter.v1beta1.OrganizationSettings
OrganizationSettingsName
OrganizationSettingsName.Builder
Builder for organizations/{organization}/organizationSettings.
OrganizationSettingsOuterClass
RunAssetDiscoveryRequest
Request message for running asset discovery for an organization.
Protobuf type google.cloud.securitycenter.v1beta1.RunAssetDiscoveryRequest
RunAssetDiscoveryRequest.Builder
Request message for running asset discovery for an organization.
Protobuf type google.cloud.securitycenter.v1beta1.RunAssetDiscoveryRequest
RunAssetDiscoveryResponse
Response of asset discovery run
Protobuf type google.cloud.securitycenter.v1beta1.RunAssetDiscoveryResponse
RunAssetDiscoveryResponse.Builder
Response of asset discovery run
Protobuf type google.cloud.securitycenter.v1beta1.RunAssetDiscoveryResponse
RunAssetDiscoveryResponseOuterClass
SecurityCenterClient
Service Description: V1 Beta APIs for Security Center service.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (SecurityCenterClient securityCenterClient = SecurityCenterClient.create()) {
OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
Source source = Source.newBuilder().build();
Source response = securityCenterClient.createSource(parent, source);
}
Note: close() needs to be called on the SecurityCenterClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of SecurityCenterSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
SecurityCenterSettings securityCenterSettings =
SecurityCenterSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
SecurityCenterClient securityCenterClient = SecurityCenterClient.create(securityCenterSettings);
To customize the endpoint:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
SecurityCenterSettings securityCenterSettings =
SecurityCenterSettings.newBuilder().setEndpoint(myEndpoint).build();
SecurityCenterClient securityCenterClient = SecurityCenterClient.create(securityCenterSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
SecurityCenterSettings securityCenterSettings =
SecurityCenterSettings.newBuilder()
.setTransportChannelProvider(
SecurityCenterSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
SecurityCenterClient securityCenterClient = SecurityCenterClient.create(securityCenterSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
SecurityCenterClient.GroupAssetsFixedSizeCollection
SecurityCenterClient.GroupAssetsPage
SecurityCenterClient.GroupAssetsPagedResponse
SecurityCenterClient.GroupFindingsFixedSizeCollection
SecurityCenterClient.GroupFindingsPage
SecurityCenterClient.GroupFindingsPagedResponse
SecurityCenterClient.ListAssetsFixedSizeCollection
SecurityCenterClient.ListAssetsPage
SecurityCenterClient.ListAssetsPagedResponse
SecurityCenterClient.ListFindingsFixedSizeCollection
SecurityCenterClient.ListFindingsPage
SecurityCenterClient.ListFindingsPagedResponse
SecurityCenterClient.ListSourcesFixedSizeCollection
SecurityCenterClient.ListSourcesPage
SecurityCenterClient.ListSourcesPagedResponse
SecurityCenterGrpc
V1 Beta APIs for Security Center service.
SecurityCenterGrpc.SecurityCenterBlockingStub
V1 Beta APIs for Security Center service.
SecurityCenterGrpc.SecurityCenterFutureStub
V1 Beta APIs for Security Center service.
SecurityCenterGrpc.SecurityCenterImplBase
V1 Beta APIs for Security Center service.
SecurityCenterGrpc.SecurityCenterStub
V1 Beta APIs for Security Center service.
SecurityCenterSettings
Settings class to configure an instance of SecurityCenterClient.
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 total timeout of createSource to 30 seconds:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
SecurityCenterSettings.Builder securityCenterSettingsBuilder =
SecurityCenterSettings.newBuilder();
securityCenterSettingsBuilder
.createSourceSettings()
.setRetrySettings(
securityCenterSettingsBuilder
.createSourceSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
SecurityCenterSettings securityCenterSettings = securityCenterSettingsBuilder.build();
SecurityCenterSettings.Builder
Builder for SecurityCenterSettings.
SecurityMarks
User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.
Protobuf type google.cloud.securitycenter.v1beta1.SecurityMarks
SecurityMarks.Builder
User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.
Protobuf type google.cloud.securitycenter.v1beta1.SecurityMarks
SecurityMarksOuterClass
SecuritycenterService
SecuritymarksName (deprecated)
Deprecated. This resource name class will be removed in the next major version.
AUTO-GENERATED DOCUMENTATION AND CLASS
SecuritymarksNames (deprecated)
Deprecated. This resource name class will be removed in the next major version.
AUTO-GENERATED DOCUMENTATION AND CLASS
SetFindingStateRequest
Request message for updating a finding's state.
Protobuf type google.cloud.securitycenter.v1beta1.SetFindingStateRequest
SetFindingStateRequest.Builder
Request message for updating a finding's state.
Protobuf type google.cloud.securitycenter.v1beta1.SetFindingStateRequest
Source
Security Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, etc.
Protobuf type google.cloud.securitycenter.v1beta1.Source
Source.Builder
Security Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, etc.
Protobuf type google.cloud.securitycenter.v1beta1.Source
SourceName
SourceName.Builder
Builder for organizations/{organization}/sources/{source}.
SourceOuterClass
UntypedSecuritymarksName (deprecated)
Deprecated. This resource name class will be removed in the next major version.
AUTO-GENERATED DOCUMENTATION AND CLASS
UpdateFindingRequest
Request message for updating or creating a finding.
Protobuf type google.cloud.securitycenter.v1beta1.UpdateFindingRequest
UpdateFindingRequest.Builder
Request message for updating or creating a finding.
Protobuf type google.cloud.securitycenter.v1beta1.UpdateFindingRequest
UpdateOrganizationSettingsRequest
Request message for updating an organization's settings.
Protobuf type google.cloud.securitycenter.v1beta1.UpdateOrganizationSettingsRequest
UpdateOrganizationSettingsRequest.Builder
Request message for updating an organization's settings.
Protobuf type google.cloud.securitycenter.v1beta1.UpdateOrganizationSettingsRequest
UpdateSecurityMarksRequest
Request message for updating a SecurityMarks resource.
Protobuf type google.cloud.securitycenter.v1beta1.UpdateSecurityMarksRequest
UpdateSecurityMarksRequest.Builder
Request message for updating a SecurityMarks resource.
Protobuf type google.cloud.securitycenter.v1beta1.UpdateSecurityMarksRequest
UpdateSourceRequest
Request message for updating a source.
Protobuf type google.cloud.securitycenter.v1beta1.UpdateSourceRequest
UpdateSourceRequest.Builder
Request message for updating a source.
Protobuf type google.cloud.securitycenter.v1beta1.UpdateSourceRequest
Interfaces
Asset.SecurityCenterPropertiesOrBuilder
AssetOrBuilder
CreateFindingRequestOrBuilder
CreateSourceRequestOrBuilder
FindingOrBuilder
GetOrganizationSettingsRequestOrBuilder
GetSourceRequestOrBuilder
GroupAssetsRequestOrBuilder
GroupAssetsResponseOrBuilder
GroupFindingsRequestOrBuilder
GroupFindingsResponseOrBuilder
GroupResultOrBuilder
ListAssetsRequestOrBuilder
ListAssetsResponse.ListAssetsResultOrBuilder
ListAssetsResponseOrBuilder
ListFindingsRequestOrBuilder
ListFindingsResponseOrBuilder
ListSourcesRequestOrBuilder
ListSourcesResponseOrBuilder
OrganizationSettings.AssetDiscoveryConfigOrBuilder
OrganizationSettingsOrBuilder
RunAssetDiscoveryRequestOrBuilder
RunAssetDiscoveryResponseOrBuilder
SecurityMarksOrBuilder
SetFindingStateRequestOrBuilder
SourceOrBuilder
UpdateFindingRequestOrBuilder
UpdateOrganizationSettingsRequestOrBuilder
UpdateSecurityMarksRequestOrBuilder
UpdateSourceRequestOrBuilder
Enums
Finding.State
The state of the finding.
Protobuf enum google.cloud.securitycenter.v1beta1.Finding.State
ListAssetsResponse.ListAssetsResult.State
State of the asset. When querying across two points in time this describes the change between the two points: ADDED, REMOVED, or ACTIVE. If there was no compare_duration supplied in the request the state should be: UNUSED
Protobuf enum
google.cloud.securitycenter.v1beta1.ListAssetsResponse.ListAssetsResult.State
OrganizationSettings.AssetDiscoveryConfig.InclusionMode
The mode of inclusion when running Asset Discovery. Asset discovery can be limited by explicitly identifying projects to be included or excluded. If INCLUDE_ONLY is set, then only those projects within the organization and their children are discovered during asset discovery. If EXCLUDE is set, then projects that don't match those projects are discovered during asset discovery. If neither are set, then all projects within the organization are discovered during asset discovery.
Protobuf enum
google.cloud.securitycenter.v1beta1.OrganizationSettings.AssetDiscoveryConfig.InclusionMode
RunAssetDiscoveryResponse.State
The state of an asset discovery run.
Protobuf enum google.cloud.securitycenter.v1beta1.RunAssetDiscoveryResponse.State