Reference documentation and code samples for the Google Cloud Storage Insights V1 Client class DatasetConfig.
Message describing the dataset configuration properties. For more information, see Dataset configuration properties .
Generated from protobuf message google.cloud.storageinsights.v1.DatasetConfig
Namespace
Google \ Cloud \ StorageInsights \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. name of resource
↳ create_time
Google\Protobuf\Timestamp
Output only. The UTC time at which the dataset configuration was created. This is auto-populated.
↳ update_time
Google\Protobuf\Timestamp
Output only. The UTC time at which the dataset configuration was last updated. This is auto-populated.
↳ labels
↳ uid
string
Output only. System generated unique identifier for the resource.
↳ organization_number
int|string
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
↳ source_folders
↳ organization_scope
bool
Defines the options for providing a source organization for the dataset.
↳ cloud_storage_object_path
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 format gs://{bucket_name}/{object_name}
.
↳ include_cloud_storage_locations
↳ exclude_cloud_storage_locations
↳ include_cloud_storage_buckets
↳ exclude_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
↳ identity
↳ status
↳ dataset_config_state
int
Output only. State of the datasetConfig
.
↳ description
string
Optional. A user-provided description for the dataset configuration. Maximum length: 256 characters.
getName
Identifier. name of resource
string
setName
Identifier. name of resource
var
string
$this
getCreateTime
Output only. The UTC time at which the dataset configuration was created.
This is auto-populated.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The UTC time at which the dataset configuration was created.
This is auto-populated.
$this
getUpdateTime
Output only. The UTC time at which the dataset configuration was last updated. This is auto-populated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The UTC time at which the dataset configuration was last updated. This is auto-populated.
$this
getLabels
Labels as key value pairs
setLabels
Labels as key value pairs
$this
getUid
Output only. System generated unique identifier for the resource.
string
setUid
Output only. System generated unique identifier for the resource.
var
string
$this
getOrganizationNumber
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.
int|string
setOrganizationNumber
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.
var
int|string
$this
getSourceProjects
Defines the options for providing source projects for the dataset.
hasSourceProjects
setSourceProjects
Defines the options for providing source projects for the dataset.
$this
getSourceFolders
Defines the options for providing source folders for the dataset.
hasSourceFolders
setSourceFolders
Defines the options for providing source folders for the dataset.
$this
getOrganizationScope
Defines the options for providing a source organization for the dataset.
bool
hasOrganizationScope
setOrganizationScope
Defines the options for providing a source organization for the dataset.
var
bool
$this
getCloudStorageObjectPath
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}.
string
hasCloudStorageObjectPath
setCloudStorageObjectPath
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}.
var
string
$this
getIncludeCloudStorageLocations
Generated from protobuf field .google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations include_cloud_storage_locations = 8;
hasIncludeCloudStorageLocations
setIncludeCloudStorageLocations
Generated from protobuf field .google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations include_cloud_storage_locations = 8;
$this
getExcludeCloudStorageLocations
Generated from protobuf field .google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations exclude_cloud_storage_locations = 9;
hasExcludeCloudStorageLocations
setExcludeCloudStorageLocations
Generated from protobuf field .google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations exclude_cloud_storage_locations = 9;
$this
getIncludeCloudStorageBuckets
Generated from protobuf field .google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets include_cloud_storage_buckets = 10;
hasIncludeCloudStorageBuckets
setIncludeCloudStorageBuckets
Generated from protobuf field .google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets include_cloud_storage_buckets = 10;
$this
getExcludeCloudStorageBuckets
Generated from protobuf field .google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets exclude_cloud_storage_buckets = 11;
hasExcludeCloudStorageBuckets
setExcludeCloudStorageBuckets
Generated from protobuf field .google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets exclude_cloud_storage_buckets = 11;
$this
getIncludeNewlyCreatedBuckets
If set to true
, the request includes all the newly created buckets in the
dataset that meet the inclusion and exclusion rules.
bool
setIncludeNewlyCreatedBuckets
If set to true
, the request includes all the newly created buckets in the
dataset that meet the inclusion and exclusion rules.
var
bool
$this
getSkipVerificationAndIngest
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.
bool
setSkipVerificationAndIngest
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.
var
bool
$this
getRetentionPeriodDays
Number of days of history that must be retained.
int
setRetentionPeriodDays
Number of days of history that must be retained.
var
int
$this
getLink
Details of the linked dataset.
hasLink
clearLink
setLink
Details of the linked dataset.
$this
getIdentity
Identity used by this datasetConfig
.
hasIdentity
clearIdentity
setIdentity
Identity used by this datasetConfig
.
$this
getStatus
Output only. Status of the datasetConfig
.
hasStatus
clearStatus
setStatus
Output only. Status of the datasetConfig
.
$this
getDatasetConfigState
Output only. State of the datasetConfig
.
int
setDatasetConfigState
Output only. State of the datasetConfig
.
var
int
$this
getDescription
Optional. A user-provided description for the dataset configuration.
Maximum length: 256 characters.
string
setDescription
Optional. A user-provided description for the dataset configuration.
Maximum length: 256 characters.
var
string
$this
getSourceOptions
string
getCloudStorageLocations
string
getCloudStorageBuckets
string
