As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Securitycenter v1beta1 API

class google.cloud.securitycenter_v1beta1.types.Asset(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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.

name

The relative resource name of this asset. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: “organizations/{organization_id}/assets/{asset_id}”.

Type

str

security_center_properties

Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user.

Type

google.cloud.securitycenter_v1beta1.types.Asset.SecurityCenterProperties

resource_properties

Resource managed properties. These properties are managed and defined by the Google Cloud resource and cannot be modified by the user.

Type

MutableMapping[str, google.protobuf.struct_pb2.Value]

security_marks

User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the asset.

Type

google.cloud.securitycenter_v1beta1.types.SecurityMarks

create_time

The time at which the asset was created in Security Command Center.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

The time at which the asset was last updated, added, or deleted in Security Command Center.

Type

google.protobuf.timestamp_pb2.Timestamp

class ResourcePropertiesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class SecurityCenterProperties(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user.

resource_name

Immutable. The full resource name of the Google Cloud resource this asset represents. This field is immutable after create time. See: https://cloud.google.com/apis/design/resource_names#full_resource_name

Type

str

resource_type

The type of the Google Cloud resource. Examples include: APPLICATION, PROJECT, and ORGANIZATION. This is a case insensitive field defined by Security Command Center and/or the producer of the resource and is immutable after create time.

Type

str

resource_parent

The full resource name of the immediate parent of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name

Type

str

resource_project

The full resource name of the project the resource belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name

Type

str

resource_owners

Owners of the Google Cloud resource.

Type

MutableSequence[str]

class google.cloud.securitycenter_v1beta1.types.CreateFindingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for creating a finding.

parent

Required. Resource name of the new finding’s parent. Its format should be “organizations/[organization_id]/sources/[source_id]”.

Type

str

finding_id

Required. Unique identifier provided by the client within the parent scope. It must be alphanumeric and less than or equal to 32 characters and greater than 0 characters in length.

Type

str

finding

Required. The Finding being created. The name and security_marks will be ignored as they are both output only fields on this resource.

Type

google.cloud.securitycenter_v1beta1.types.Finding

class google.cloud.securitycenter_v1beta1.types.CreateSourceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for creating a source.

parent

Required. Resource name of the new source’s parent. Its format should be “organizations/[organization_id]”.

Type

str

source

Required. The Source being created, only the display_name and description will be used. All other fields will be ignored.

Type

google.cloud.securitycenter_v1beta1.types.Source

class google.cloud.securitycenter_v1beta1.types.Finding(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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.

name

The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: “organizations/{organization_id}/sources/{source_id}/findings/{finding_id}”.

Type

str

parent

Immutable. The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: “organizations/{organization_id}/sources/{source_id}”.

Type

str

resource_name

For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time.

Type

str

state

The state of the finding.

Type

google.cloud.securitycenter_v1beta1.types.Finding.State

category

The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: “XSS_FLASH_INJECTION”.

Type

str

external_uri

The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL.

Type

str

source_properties

Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only.

Type

MutableMapping[str, google.protobuf.struct_pb2.Value]

security_marks

Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.

Type

google.cloud.securitycenter_v1beta1.types.SecurityMarks

event_time

The time at which the event took place, or when an update to the finding occurred. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding were to be resolved afterward, this time would reflect when the finding was resolved.

Type

google.protobuf.timestamp_pb2.Timestamp

create_time

The time at which the finding was created in Security Command Center.

Type

google.protobuf.timestamp_pb2.Timestamp

class SourcePropertiesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class State(value)[source]

Bases: proto.enums.Enum

The state of the finding.

Values:
STATE_UNSPECIFIED (0):

Unspecified state.

ACTIVE (1):

The finding requires attention and has not been addressed yet.

INACTIVE (2):

The finding has been fixed, triaged as a non-issue or otherwise addressed and is no longer active.

class google.cloud.securitycenter_v1beta1.types.GetOrganizationSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for getting organization settings.

name

Required. Name of the organization to get organization settings for. Its format is “organizations/[organization_id]/organizationSettings”.

Type

str

class google.cloud.securitycenter_v1beta1.types.GetSourceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for getting a source.

name

Required. Relative resource name of the source. Its format is “organizations/[organization_id]/source/[source_id]”.

Type

str

class google.cloud.securitycenter_v1beta1.types.GroupAssetsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for grouping by assets.

parent

Required. Name of the organization to groupBy. Its format is “organizations/[organization_id]”.

Type

str

filter

Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators AND and OR. Parentheses are not supported, and OR has higher precedence than AND.

Restrictions have the form <field> <operator> <value> and may have a - character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include:

  • name

  • security_center_properties.resource_name

  • resource_properties.a_property

  • security_marks.marks.marka

The supported operators are:

  • = for all value types.

  • >, <, >=, <= for integer values.

  • :, meaning substring matching, for strings.

The supported value types are:

  • string literals in quotes.

  • integer literals without quotes.

  • boolean literals true and false without quotes.

For example, resource_properties.size = 100 is a valid filter string.

Type

str

group_by

Required. Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: “security_center_properties.resource_project,security_center_properties.project”.

The following fields are supported when compare_duration is not set:

  • security_center_properties.resource_project

  • security_center_properties.resource_type

  • security_center_properties.resource_parent

The following fields are supported when compare_duration is set:

  • security_center_properties.resource_type

Type

str

compare_duration

When compare_duration is set, the Asset’s “state” property is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time.

The state value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don’t affect the result. For example, the results aren’t affected if the asset is removed and re-created again.

Possible “state” values when compare_duration is specified:

  • “ADDED”: indicates that the asset was not present before compare_duration, but present at reference_time.

  • “REMOVED”: indicates that the asset was present at the start of compare_duration, but not present at reference_time.

  • “ACTIVE”: indicates that the asset was present at both the start and the end of the time period defined by compare_duration and reference_time.

This field is ignored if state is not a field in group_by.

Type

google.protobuf.duration_pb2.Duration

read_time

Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API’s version of NOW.

Type

google.protobuf.timestamp_pb2.Timestamp

page_token

The value returned by the last GroupAssetsResponse; indicates that this is a continuation of a prior GroupAssets call, and that the system should return the next page of data.

Type

str

page_size

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.

Type

int

class google.cloud.securitycenter_v1beta1.types.GroupAssetsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for grouping by assets.

group_by_results

Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear.

Type

MutableSequence[google.cloud.securitycenter_v1beta1.types.GroupResult]

read_time

Time used for executing the groupBy request.

Type

google.protobuf.timestamp_pb2.Timestamp

next_page_token

Token to retrieve the next page of results, or empty if there are no more results.

Type

str

class google.cloud.securitycenter_v1beta1.types.GroupFindingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for grouping by findings.

parent

Required. Name of the source to groupBy. Its format is “organizations/[organization_id]/sources/[source_id]”. To groupBy across all sources provide a source_id of -. For example: organizations/{organization_id}/sources/-

Type

str

filter

Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators AND and OR. Parentheses are not supported, and OR has higher precedence than AND.

Restrictions have the form <field> <operator> <value> and may have a - character in front of them to indicate negation. Examples include:

  • name

  • source_properties.a_property

  • security_marks.marks.marka

The supported operators are:

  • = for all value types.

  • >, <, >=, <= for integer values.

  • :, meaning substring matching, for strings.

The supported value types are:

  • string literals in quotes.

  • integer literals without quotes.

  • boolean literals true and false without quotes.

For example, source_properties.size = 100 is a valid filter string.

Type

str

group_by

Required. Expression that defines what assets fields to use for grouping (including state). The string value should follow SQL syntax: comma separated list of fields. For example: “parent,resource_name”.

The following fields are supported:

  • resource_name

  • category

  • state

  • parent

Type

str

read_time

Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API’s version of NOW.

Type

google.protobuf.timestamp_pb2.Timestamp

page_token

The value returned by the last GroupFindingsResponse; indicates that this is a continuation of a prior GroupFindings call, and that the system should return the next page of data.

Type

str

page_size

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.

Type

int

class google.cloud.securitycenter_v1beta1.types.GroupFindingsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for group by findings.

group_by_results

Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear.

Type

MutableSequence[google.cloud.securitycenter_v1beta1.types.GroupResult]

read_time

Time used for executing the groupBy request.

Type

google.protobuf.timestamp_pb2.Timestamp

next_page_token

Token to retrieve the next page of results, or empty if there are no more results.

Type

str

class google.cloud.securitycenter_v1beta1.types.GroupResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Result containing the properties and count of a groupBy request.

properties

Properties matching the groupBy fields in the request.

Type

MutableMapping[str, google.protobuf.struct_pb2.Value]

count

Total count of resources for the given properties.

Type

int

class PropertiesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.securitycenter_v1beta1.types.ListAssetsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for listing assets.

parent

Required. Name of the organization assets should belong to. Its format is “organizations/[organization_id]”.

Type

str

filter

Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators AND and OR. Parentheses are not supported, and OR has higher precedence than AND.

Restrictions have the form <field> <operator> <value> and may have a - character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include:

  • name

  • security_center_properties.resource_name

  • resource_properties.a_property

  • security_marks.marks.marka

The supported operators are:

  • = for all value types.

  • >, <, >=, <= for integer values.

  • :, meaning substring matching, for strings.

The supported value types are:

  • string literals in quotes.

  • integer literals without quotes.

  • boolean literals true and false without quotes.

For example, resource_properties.size = 100 is a valid filter string.

Type

str

order_by

Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: “name,resource_properties.a_property”. The default sorting order is ascending. To specify descending order for a field, a suffix ” desc” should be appended to the field name. For example: “name desc,resource_properties.a_property”. Redundant space characters in the syntax are insignificant. “name desc,resource_properties.a_property” and ” name desc , resource_properties.a_property ” are equivalent.

Type

str

read_time

Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API’s version of NOW.

Type

google.protobuf.timestamp_pb2.Timestamp

compare_duration

When compare_duration is set, the ListAssetResult’s “state” attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time.

The state value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don’t affect the result. For example, the results aren’t affected if the asset is removed and re-created again.

Possible “state” values when compare_duration is specified:

  • “ADDED”: indicates that the asset was not present before compare_duration, but present at read_time.

  • “REMOVED”: indicates that the asset was present at the start of compare_duration, but not present at read_time.

  • “ACTIVE”: indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time.

If compare_duration is not specified, then the only possible state is “UNUSED”, which indicates that the asset is present at read_time.

Type

google.protobuf.duration_pb2.Duration

field_mask

Optional. A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields.

Type

google.protobuf.field_mask_pb2.FieldMask

page_token

The value returned by the last ListAssetsResponse; indicates that this is a continuation of a prior ListAssets call, and that the system should return the next page of data.

Type

str

page_size

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.

Type

int

class google.cloud.securitycenter_v1beta1.types.ListAssetsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for listing assets.

list_assets_results

Assets matching the list request.

Type

MutableSequence[google.cloud.securitycenter_v1beta1.types.ListAssetsResponse.ListAssetsResult]

read_time

Time used for executing the list request.

Type

google.protobuf.timestamp_pb2.Timestamp

next_page_token

Token to retrieve the next page of results, or empty if there are no more results.

Type

str

total_size

The total number of assets matching the query.

Type

int

class ListAssetsResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Result containing the Asset and its State.

asset

Asset matching the search request.

Type

google.cloud.securitycenter_v1beta1.types.Asset

state

State of the asset.

Type

google.cloud.securitycenter_v1beta1.types.ListAssetsResponse.ListAssetsResult.State

class State(value)[source]

Bases: proto.enums.Enum

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

Values:
STATE_UNSPECIFIED (0):

Unspecified state.

UNUSED (1):

Request did not specify use of this field in the result.

ADDED (2):

Asset was added between the points in time.

REMOVED (3):

Asset was removed between the points in time.

ACTIVE (4):

Asset was active at both point(s) in time.

class google.cloud.securitycenter_v1beta1.types.ListFindingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for listing findings.

parent

Required. Name of the source the findings belong to. Its format is “organizations/[organization_id]/sources/[source_id]”. To list across all sources provide a source_id of -. For example: organizations/{organization_id}/sources/-

Type

str

filter

Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators AND and OR. Parentheses are not supported, and OR has higher precedence than AND.

Restrictions have the form <field> <operator> <value> and may have a - character in front of them to indicate negation. Examples include:

  • name

  • source_properties.a_property

  • security_marks.marks.marka

The supported operators are:

  • = for all value types.

  • >, <, >=, <= for integer values.

  • :, meaning substring matching, for strings.

The supported value types are:

  • string literals in quotes.

  • integer literals without quotes.

  • boolean literals true and false without quotes.

For example, source_properties.size = 100 is a valid filter string.

Type

str

order_by

Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: “name,resource_properties.a_property”. The default sorting order is ascending. To specify descending order for a field, a suffix ” desc” should be appended to the field name. For example: “name desc,source_properties.a_property”. Redundant space characters in the syntax are insignificant. “name desc,source_properties.a_property” and ” name desc , source_properties.a_property ” are equivalent.

Type

str

read_time

Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API’s version of NOW.

Type

google.protobuf.timestamp_pb2.Timestamp

field_mask

Optional. A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.

Type

google.protobuf.field_mask_pb2.FieldMask

page_token

The value returned by the last ListFindingsResponse; indicates that this is a continuation of a prior ListFindings call, and that the system should return the next page of data.

Type

str

page_size

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.

Type

int

class google.cloud.securitycenter_v1beta1.types.ListFindingsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for listing findings.

findings

Findings matching the list request.

Type

MutableSequence[google.cloud.securitycenter_v1beta1.types.Finding]

read_time

Time used for executing the list request.

Type

google.protobuf.timestamp_pb2.Timestamp

next_page_token

Token to retrieve the next page of results, or empty if there are no more results.

Type

str

total_size

The total number of findings matching the query.

Type

int

class google.cloud.securitycenter_v1beta1.types.ListSourcesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for listing sources.

parent

Required. Resource name of the parent of sources to list. Its format should be “organizations/[organization_id]”.

Type

str

page_token

The value returned by the last ListSourcesResponse; indicates that this is a continuation of a prior ListSources call, and that the system should return the next page of data.

Type

str

page_size

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.

Type

int

class google.cloud.securitycenter_v1beta1.types.ListSourcesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for listing sources.

sources

Sources belonging to the requested parent.

Type

MutableSequence[google.cloud.securitycenter_v1beta1.types.Source]

next_page_token

Token to retrieve the next page of results, or empty if there are no more results.

Type

str

class google.cloud.securitycenter_v1beta1.types.OrganizationSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

User specified settings that are attached to the Security Command Center organization.

name

The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: “organizations/{organization_id}/organizationSettings”.

Type

str

enable_asset_discovery

A flag that indicates if Asset Discovery should be enabled. If the flag is set to true, then discovery of assets will occur. If it is set to `false, all historical assets will remain, but discovery of future assets will not occur.

Type

bool

asset_discovery_config

The configuration used for Asset Discovery runs.

Type

google.cloud.securitycenter_v1beta1.types.OrganizationSettings.AssetDiscoveryConfig

class AssetDiscoveryConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The configuration used for Asset Discovery runs.

project_ids

The project ids to use for filtering asset discovery.

Type

MutableSequence[str]

inclusion_mode

The mode to use for filtering asset discovery.

Type

google.cloud.securitycenter_v1beta1.types.OrganizationSettings.AssetDiscoveryConfig.InclusionMode

class InclusionMode(value)[source]

Bases: proto.enums.Enum

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.

Values:
INCLUSION_MODE_UNSPECIFIED (0):

Unspecified. Setting the mode with this value will disable inclusion/exclusion filtering for Asset Discovery.

INCLUDE_ONLY (1):

Asset Discovery will capture only the resources within the projects specified. All other resources will be ignored.

EXCLUDE (2):

Asset Discovery will ignore all resources under the projects specified. All other resources will be retrieved.

class google.cloud.securitycenter_v1beta1.types.RunAssetDiscoveryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for running asset discovery for an organization.

parent

Required. Name of the organization to run asset discovery for. Its format is “organizations/[organization_id]”.

Type

str

class google.cloud.securitycenter_v1beta1.types.RunAssetDiscoveryResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response of asset discovery run

state

The state of an asset discovery run.

Type

google.cloud.securitycenter_v1beta1.types.RunAssetDiscoveryResponse.State

duration

The duration between asset discovery run start and end

Type

google.protobuf.duration_pb2.Duration

class State(value)[source]

Bases: proto.enums.Enum

The state of an asset discovery run.

Values:
STATE_UNSPECIFIED (0):

Asset discovery run state was unspecified.

COMPLETED (1):

Asset discovery run completed successfully.

SUPERSEDED (2):

Asset discovery run was cancelled with tasks still pending, as another run for the same organization was started with a higher priority.

TERMINATED (3):

Asset discovery run was killed and terminated.

class google.cloud.securitycenter_v1beta1.types.SecurityMarks(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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.

name

The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: “organizations/{organization_id}/assets/{asset_id}/securityMarks” “organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks”.

Type

str

marks

Mutable user specified security marks belonging to the parent resource. Constraints are as follows:

  • Keys and values are treated as case insensitive

  • Keys must be between 1 - 256 characters (inclusive)

  • Keys must be letters, numbers, underscores, or dashes

  • Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)

Type

MutableMapping[str, str]

class MarksEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.securitycenter_v1beta1.types.SetFindingStateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for updating a finding’s state.

name

Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: “organizations/{organization_id}/sources/{source_id}/finding/{finding_id}”.

Type

str

state

Required. The desired State of the finding.

Type

google.cloud.securitycenter_v1beta1.types.Finding.State

start_time

Required. The time at which the updated state takes effect.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.securitycenter_v1beta1.types.Source(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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.

name

The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: “organizations/{organization_id}/sources/{source_id}”.

Type

str

display_name

The source’s display name. A source’s display name must be unique amongst its siblings, for example, two sources with the same parent can’t share the same display name. The display name must have a length between 1 and 64 characters (inclusive).

Type

str

description

The description of the source (max of 1024 characters). Example:

“Web Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated/insecure libraries.”.

Type

str

class google.cloud.securitycenter_v1beta1.types.UpdateFindingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for updating or creating a finding.

finding

Required. The finding resource to update or create if it does not already exist. parent, security_marks, and update_time will be ignored.

In the case of creation, the finding id portion of the name must alphanumeric and less than or equal to 32 characters and greater than 0 characters in length.

Type

google.cloud.securitycenter_v1beta1.types.Finding

update_mask

The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.securitycenter_v1beta1.types.UpdateOrganizationSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for updating an organization’s settings.

organization_settings

Required. The organization settings resource to update.

Type

google.cloud.securitycenter_v1beta1.types.OrganizationSettings

update_mask

The FieldMask to use when updating the settings resource.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.securitycenter_v1beta1.types.UpdateSecurityMarksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for updating a SecurityMarks resource.

security_marks

Required. The security marks resource to update.

Type

google.cloud.securitycenter_v1beta1.types.SecurityMarks

update_mask

The FieldMask to use when updating the security marks resource.

Type

google.protobuf.field_mask_pb2.FieldMask

start_time

The time at which the updated SecurityMarks take effect.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.securitycenter_v1beta1.types.UpdateSourceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for updating a source.

source

Required. The source resource to update.

Type

google.cloud.securitycenter_v1beta1.types.Source

update_mask

The FieldMask to use when updating the source resource.

Type

google.protobuf.field_mask_pb2.FieldMask