DatasetConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)Message describing the dataset configuration properties. For more
information, see Dataset configuration
properties <https://cloud.google.com/storage/docs/insights/datasets#dataset-config>__.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes |
|
|---|---|
| Name | Description |
name |
str
Identifier. name of resource |
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The UTC time at which the dataset configuration was created. This is auto-populated. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The UTC time at which the dataset configuration was last updated. This is auto-populated. |
labels |
MutableMapping[str, str]
Labels as key value pairs |
uid |
str
Output only. System generated unique identifier for the resource. |
organization_number |
int
Optional. Organization resource ID that the source projects should belong to. Projects that do not belong to the provided organization are not considered when creating the dataset. |
source_projects |
google.cloud.storageinsights_v1.types.DatasetConfig.SourceProjects
Defines the options for providing source projects for the dataset. This field is a member of oneof_ source_options.
|
source_folders |
google.cloud.storageinsights_v1.types.DatasetConfig.SourceFolders
Defines the options for providing source folders for the dataset. This field is a member of oneof_ source_options.
|
organization_scope |
bool
Defines the options for providing a source organization for the dataset. This field is a member of oneof_ source_options.
|
cloud_storage_object_path |
str
Input only. Cloud Storage object path containing a list of project or folder numbers to include in the dataset; it cannot contain a mix of project and folders. The object must be a text file where each line has one of the following entries: - Project number, formatted as projects/{project_number}, for example,
projects/1234567890.
- Folder identifier, formatted as
folders/{folder_number}, for example,
folders/9876543210. Path must be in the format
gs://{bucket_name}/{object_name}.
This field is a member of oneof_ source_options.
|
include_cloud_storage_locations |
google.cloud.storageinsights_v1.types.DatasetConfig.CloudStorageLocations
This field is a member of oneof_ cloud_storage_locations.
|
exclude_cloud_storage_locations |
google.cloud.storageinsights_v1.types.DatasetConfig.CloudStorageLocations
This field is a member of oneof_ cloud_storage_locations.
|
include_cloud_storage_buckets |
google.cloud.storageinsights_v1.types.DatasetConfig.CloudStorageBuckets
This field is a member of oneof_ cloud_storage_buckets.
|
exclude_cloud_storage_buckets |
google.cloud.storageinsights_v1.types.DatasetConfig.CloudStorageBuckets
This field is a member of oneof_ cloud_storage_buckets.
|
include_newly_created_buckets |
bool
If set to true, the request includes all the newly
created buckets in the dataset that meet the inclusion and
exclusion rules.
|
skip_verification_and_ingest |
bool
Optional. If set to false, then all the permission
checks must be successful before the system can start
ingesting data. This field can only be updated before the
system ingests data for the first time. Any attempt to
modify the field after data ingestion starts results in an
error.
|
retention_period_days |
int
Number of days of history that must be retained. |
link |
google.cloud.storageinsights_v1.types.DatasetConfig.Link
Details of the linked dataset. |
identity |
google.cloud.storageinsights_v1.types.Identity
Identity used by this datasetConfig.
|
status |
google.rpc.status_pb2.Status
Output only. Status of the datasetConfig.
|
dataset_config_state |
google.cloud.storageinsights_v1.types.DatasetConfig.ConfigState
Output only. State of the datasetConfig.
|
description |
str
Optional. A user-provided description for the dataset configuration. Maximum length: 256 characters. |
Classes
BucketErrors
BucketErrors(mapping=None, *, ignore_unknown_fields=False, **kwargs)Provides a summary of the bucket level error statistics.
CloudStorageBuckets
CloudStorageBuckets(mapping=None, *, ignore_unknown_fields=False, **kwargs)Collection of Cloud Storage buckets.
CloudStorageLocations
CloudStorageLocations(mapping=None, *, ignore_unknown_fields=False, **kwargs)Collection of Cloud Storage locations.
ConfigState
ConfigState(value)State of the configuration.
LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
Link
Link(mapping=None, *, ignore_unknown_fields=False, **kwargs)Defines the details about the linked dataset.
ProjectErrors
ProjectErrors(mapping=None, *, ignore_unknown_fields=False, **kwargs)Provides a summary of the project level error statistics.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SourceFolders
SourceFolders(mapping=None, *, ignore_unknown_fields=False, **kwargs)Specifies a set of folders to include in the dataset
SourceProjects
SourceProjects(mapping=None, *, ignore_unknown_fields=False, **kwargs)Collection of project numbers
ValidationErrorsBeforeIngestion
ValidationErrorsBeforeIngestion(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)Summary of validation errors that occurred during the verification phase.