Reference documentation and code samples for the Storage Insights V1 API class Google::Cloud::StorageInsights::V1::DatasetConfig.
Message describing the dataset configuration properties. For more information, see Dataset configuration properties.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#cloud_storage_object_path
def cloud_storage_object_path() -> ::String-
(::String) — 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 formatgs://{bucket_name}/{object_name}.
Note: The following fields are mutually exclusive:
cloud_storage_object_path,source_projects,source_folders,organization_scope. If a field in that set is populated, all other fields in the set will automatically be cleared. - Project number, formatted as
#cloud_storage_object_path=
def cloud_storage_object_path=(value) -> ::String-
value (::String) — 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 formatgs://{bucket_name}/{object_name}.
Note: The following fields are mutually exclusive:
cloud_storage_object_path,source_projects,source_folders,organization_scope. If a field in that set is populated, all other fields in the set will automatically be cleared. - Project number, formatted as
-
(::String) — 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 formatgs://{bucket_name}/{object_name}.
Note: The following fields are mutually exclusive:
cloud_storage_object_path,source_projects,source_folders,organization_scope. If a field in that set is populated, all other fields in the set will automatically be cleared. - Project number, formatted as
#create_time
def create_time() -> ::Google::Protobuf::Timestamp- (::Google::Protobuf::Timestamp) — Output only. The UTC time at which the dataset configuration was created. This is auto-populated.
#dataset_config_state
def dataset_config_state() -> ::Google::Cloud::StorageInsights::V1::DatasetConfig::ConfigState-
(::Google::Cloud::StorageInsights::V1::DatasetConfig::ConfigState) — Output only. State of the
datasetConfig.
#description
def description() -> ::String-
(::String) — Optional. A user-provided description for the dataset configuration.
Maximum length: 256 characters.
#description=
def description=(value) -> ::String-
value (::String) — Optional. A user-provided description for the dataset configuration.
Maximum length: 256 characters.
-
(::String) — Optional. A user-provided description for the dataset configuration.
Maximum length: 256 characters.
#exclude_cloud_storage_buckets
def exclude_cloud_storage_buckets() -> ::Google::Cloud::StorageInsights::V1::DatasetConfig::CloudStorageBuckets-
(::Google::Cloud::StorageInsights::V1::DatasetConfig::CloudStorageBuckets) — Note: The following fields are mutually exclusive:
exclude_cloud_storage_buckets,include_cloud_storage_buckets. If a field in that set is populated, all other fields in the set will automatically be cleared.
#exclude_cloud_storage_buckets=
def exclude_cloud_storage_buckets=(value) -> ::Google::Cloud::StorageInsights::V1::DatasetConfig::CloudStorageBuckets-
value (::Google::Cloud::StorageInsights::V1::DatasetConfig::CloudStorageBuckets) — Note: The following fields are mutually exclusive:
exclude_cloud_storage_buckets,include_cloud_storage_buckets. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::StorageInsights::V1::DatasetConfig::CloudStorageBuckets) — Note: The following fields are mutually exclusive:
exclude_cloud_storage_buckets,include_cloud_storage_buckets. If a field in that set is populated, all other fields in the set will automatically be cleared.
#exclude_cloud_storage_locations
def exclude_cloud_storage_locations() -> ::Google::Cloud::StorageInsights::V1::DatasetConfig::CloudStorageLocations-
(::Google::Cloud::StorageInsights::V1::DatasetConfig::CloudStorageLocations) — Note: The following fields are mutually exclusive:
exclude_cloud_storage_locations,include_cloud_storage_locations. If a field in that set is populated, all other fields in the set will automatically be cleared.
#exclude_cloud_storage_locations=
def exclude_cloud_storage_locations=(value) -> ::Google::Cloud::StorageInsights::V1::DatasetConfig::CloudStorageLocations-
value (::Google::Cloud::StorageInsights::V1::DatasetConfig::CloudStorageLocations) — Note: The following fields are mutually exclusive:
exclude_cloud_storage_locations,include_cloud_storage_locations. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::StorageInsights::V1::DatasetConfig::CloudStorageLocations) — Note: The following fields are mutually exclusive:
exclude_cloud_storage_locations,include_cloud_storage_locations. If a field in that set is populated, all other fields in the set will automatically be cleared.
#identity
def identity() -> ::Google::Cloud::StorageInsights::V1::Identity-
(::Google::Cloud::StorageInsights::V1::Identity) — Identity used by this
datasetConfig.
#identity=
def identity=(value) -> ::Google::Cloud::StorageInsights::V1::Identity-
value (::Google::Cloud::StorageInsights::V1::Identity) — Identity used by this
datasetConfig.
-
(::Google::Cloud::StorageInsights::V1::Identity) — Identity used by this
datasetConfig.
#include_cloud_storage_buckets
def include_cloud_storage_buckets() -> ::Google::Cloud::StorageInsights::V1::DatasetConfig::CloudStorageBuckets-
(::Google::Cloud::StorageInsights::V1::DatasetConfig::CloudStorageBuckets) — Note: The following fields are mutually exclusive:
include_cloud_storage_buckets,exclude_cloud_storage_buckets. If a field in that set is populated, all other fields in the set will automatically be cleared.
#include_cloud_storage_buckets=
def include_cloud_storage_buckets=(value) -> ::Google::Cloud::StorageInsights::V1::DatasetConfig::CloudStorageBuckets-
value (::Google::Cloud::StorageInsights::V1::DatasetConfig::CloudStorageBuckets) — Note: The following fields are mutually exclusive:
include_cloud_storage_buckets,exclude_cloud_storage_buckets. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::StorageInsights::V1::DatasetConfig::CloudStorageBuckets) — Note: The following fields are mutually exclusive:
include_cloud_storage_buckets,exclude_cloud_storage_buckets. If a field in that set is populated, all other fields in the set will automatically be cleared.
#include_cloud_storage_locations
def include_cloud_storage_locations() -> ::Google::Cloud::StorageInsights::V1::DatasetConfig::CloudStorageLocations-
(::Google::Cloud::StorageInsights::V1::DatasetConfig::CloudStorageLocations) — Note: The following fields are mutually exclusive:
include_cloud_storage_locations,exclude_cloud_storage_locations. If a field in that set is populated, all other fields in the set will automatically be cleared.
#include_cloud_storage_locations=
def include_cloud_storage_locations=(value) -> ::Google::Cloud::StorageInsights::V1::DatasetConfig::CloudStorageLocations-
value (::Google::Cloud::StorageInsights::V1::DatasetConfig::CloudStorageLocations) — Note: The following fields are mutually exclusive:
include_cloud_storage_locations,exclude_cloud_storage_locations. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::StorageInsights::V1::DatasetConfig::CloudStorageLocations) — Note: The following fields are mutually exclusive:
include_cloud_storage_locations,exclude_cloud_storage_locations. If a field in that set is populated, all other fields in the set will automatically be cleared.
#include_newly_created_buckets
def include_newly_created_buckets() -> ::Boolean-
(::Boolean) — If set to
true, the request includes all the newly created buckets in the dataset that meet the inclusion and exclusion rules.
#include_newly_created_buckets=
def include_newly_created_buckets=(value) -> ::Boolean-
value (::Boolean) — If set to
true, the request includes all the newly created buckets in the dataset that meet the inclusion and exclusion rules.
-
(::Boolean) — If set to
true, the request includes all the newly created buckets in the dataset that meet the inclusion and exclusion rules.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}- (::Google::Protobuf::Map{::String => ::String}) — Labels as key value pairs
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}- value (::Google::Protobuf::Map{::String => ::String}) — Labels as key value pairs
- (::Google::Protobuf::Map{::String => ::String}) — Labels as key value pairs
#link
def link() -> ::Google::Cloud::StorageInsights::V1::DatasetConfig::Link- (::Google::Cloud::StorageInsights::V1::DatasetConfig::Link) — Details of the linked dataset.
#link=
def link=(value) -> ::Google::Cloud::StorageInsights::V1::DatasetConfig::Link- value (::Google::Cloud::StorageInsights::V1::DatasetConfig::Link) — Details of the linked dataset.
- (::Google::Cloud::StorageInsights::V1::DatasetConfig::Link) — Details of the linked dataset.
#name
def name() -> ::String- (::String) — Identifier. name of resource
#name=
def name=(value) -> ::String- value (::String) — Identifier. name of resource
- (::String) — Identifier. name of resource
#organization_number
def organization_number() -> ::Integer- (::Integer) — 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.
#organization_number=
def organization_number=(value) -> ::Integer- value (::Integer) — 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.
- (::Integer) — 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.
#organization_scope
def organization_scope() -> ::Boolean-
(::Boolean) — Defines the options for providing a source organization for the dataset.
Note: The following fields are mutually exclusive:
organization_scope,source_projects,source_folders,cloud_storage_object_path. If a field in that set is populated, all other fields in the set will automatically be cleared.
#organization_scope=
def organization_scope=(value) -> ::Boolean-
value (::Boolean) — Defines the options for providing a source organization for the dataset.
Note: The following fields are mutually exclusive:
organization_scope,source_projects,source_folders,cloud_storage_object_path. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Boolean) — Defines the options for providing a source organization for the dataset.
Note: The following fields are mutually exclusive:
organization_scope,source_projects,source_folders,cloud_storage_object_path. If a field in that set is populated, all other fields in the set will automatically be cleared.
#retention_period_days
def retention_period_days() -> ::Integer- (::Integer) — Number of days of history that must be retained.
#retention_period_days=
def retention_period_days=(value) -> ::Integer- value (::Integer) — Number of days of history that must be retained.
- (::Integer) — Number of days of history that must be retained.
#skip_verification_and_ingest
def skip_verification_and_ingest() -> ::Boolean-
(::Boolean) — 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.
#skip_verification_and_ingest=
def skip_verification_and_ingest=(value) -> ::Boolean-
value (::Boolean) — 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.
-
(::Boolean) — 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.
#source_folders
def source_folders() -> ::Google::Cloud::StorageInsights::V1::DatasetConfig::SourceFolders-
(::Google::Cloud::StorageInsights::V1::DatasetConfig::SourceFolders) — Defines the options for providing source folders for the dataset.
Note: The following fields are mutually exclusive:
source_folders,source_projects,organization_scope,cloud_storage_object_path. If a field in that set is populated, all other fields in the set will automatically be cleared.
#source_folders=
def source_folders=(value) -> ::Google::Cloud::StorageInsights::V1::DatasetConfig::SourceFolders-
value (::Google::Cloud::StorageInsights::V1::DatasetConfig::SourceFolders) — Defines the options for providing source folders for the dataset.
Note: The following fields are mutually exclusive:
source_folders,source_projects,organization_scope,cloud_storage_object_path. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::StorageInsights::V1::DatasetConfig::SourceFolders) — Defines the options for providing source folders for the dataset.
Note: The following fields are mutually exclusive:
source_folders,source_projects,organization_scope,cloud_storage_object_path. If a field in that set is populated, all other fields in the set will automatically be cleared.
#source_projects
def source_projects() -> ::Google::Cloud::StorageInsights::V1::DatasetConfig::SourceProjects-
(::Google::Cloud::StorageInsights::V1::DatasetConfig::SourceProjects) — Defines the options for providing source projects for the dataset.
Note: The following fields are mutually exclusive:
source_projects,source_folders,organization_scope,cloud_storage_object_path. If a field in that set is populated, all other fields in the set will automatically be cleared.
#source_projects=
def source_projects=(value) -> ::Google::Cloud::StorageInsights::V1::DatasetConfig::SourceProjects-
value (::Google::Cloud::StorageInsights::V1::DatasetConfig::SourceProjects) — Defines the options for providing source projects for the dataset.
Note: The following fields are mutually exclusive:
source_projects,source_folders,organization_scope,cloud_storage_object_path. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::StorageInsights::V1::DatasetConfig::SourceProjects) — Defines the options for providing source projects for the dataset.
Note: The following fields are mutually exclusive:
source_projects,source_folders,organization_scope,cloud_storage_object_path. If a field in that set is populated, all other fields in the set will automatically be cleared.
#status
def status() -> ::Google::Rpc::Status-
(::Google::Rpc::Status) — Output only. Status of the
datasetConfig.
#uid
def uid() -> ::String- (::String) — Output only. System generated unique identifier for the resource.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp- (::Google::Protobuf::Timestamp) — Output only. The UTC time at which the dataset configuration was last updated. This is auto-populated.