Google Cloud Storage Insights V1 Client - Class DatasetConfig (1.2.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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 array|Google\Protobuf\Internal\MapField

Labels as key value pairs
↳ 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 DatasetConfig\SourceProjects

Defines the options for providing source projects for the dataset.
↳ source_folders DatasetConfig\SourceFolders

Defines the options for providing source folders for the dataset.
↳ 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 DatasetConfig\CloudStorageLocations
↳ exclude_cloud_storage_locations DatasetConfig\CloudStorageLocations
↳ include_cloud_storage_buckets DatasetConfig\CloudStorageBuckets
↳ exclude_cloud_storage_buckets DatasetConfig\CloudStorageBuckets
↳ 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 DatasetConfig\Link

Details of the linked dataset.
↳ identity Identity

Identity used by this datasetConfig.
↳ status Google\Rpc\Status

Output only. Status of the datasetConfig.
↳ 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

Returns
Type Description
string

setName

Identifier. name of resource

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The UTC time at which the dataset configuration was created.

This is auto-populated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The UTC time at which the dataset configuration was created.

This is auto-populated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. The UTC time at which the dataset configuration was last updated. This is auto-populated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The UTC time at which the dataset configuration was last updated. This is auto-populated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getLabels

Labels as key value pairs

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Labels as key value pairs

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getUid

Output only. System generated unique identifier for the resource.

Returns
Type Description
string

setUid

Output only. System generated unique identifier for the resource.

Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getSourceProjects

Defines the options for providing source projects for the dataset.

Returns
Type Description
DatasetConfig\SourceProjects|null

hasSourceProjects

setSourceProjects

Defines the options for providing source projects for the dataset.

Parameter
Name Description
var DatasetConfig\SourceProjects
Returns
Type Description
$this

getSourceFolders

Defines the options for providing source folders for the dataset.

Returns
Type Description
DatasetConfig\SourceFolders|null

hasSourceFolders

setSourceFolders

Defines the options for providing source folders for the dataset.

Parameter
Name Description
var DatasetConfig\SourceFolders
Returns
Type Description
$this

getOrganizationScope

Defines the options for providing a source organization for the dataset.

Returns
Type Description
bool

hasOrganizationScope

setOrganizationScope

Defines the options for providing a source organization for the dataset.

Parameter
Name Description
var bool
Returns
Type Description
$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 format gs://{bucket_name}/{object_name}.
Returns
Type Description
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 format gs://{bucket_name}/{object_name}.
Parameter
Name Description
var string
Returns
Type Description
$this

getIncludeCloudStorageLocations

Generated from protobuf field .google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations include_cloud_storage_locations = 8;

Returns
Type Description
DatasetConfig\CloudStorageLocations|null

hasIncludeCloudStorageLocations

setIncludeCloudStorageLocations

Generated from protobuf field .google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations include_cloud_storage_locations = 8;

Parameter
Name Description
var DatasetConfig\CloudStorageLocations
Returns
Type Description
$this

getExcludeCloudStorageLocations

Generated from protobuf field .google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations exclude_cloud_storage_locations = 9;

Returns
Type Description
DatasetConfig\CloudStorageLocations|null

hasExcludeCloudStorageLocations

setExcludeCloudStorageLocations

Generated from protobuf field .google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations exclude_cloud_storage_locations = 9;

Parameter
Name Description
var DatasetConfig\CloudStorageLocations
Returns
Type Description
$this

getIncludeCloudStorageBuckets

Generated from protobuf field .google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets include_cloud_storage_buckets = 10;

Returns
Type Description
DatasetConfig\CloudStorageBuckets|null

hasIncludeCloudStorageBuckets

setIncludeCloudStorageBuckets

Generated from protobuf field .google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets include_cloud_storage_buckets = 10;

Parameter
Name Description
var DatasetConfig\CloudStorageBuckets
Returns
Type Description
$this

getExcludeCloudStorageBuckets

Generated from protobuf field .google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets exclude_cloud_storage_buckets = 11;

Returns
Type Description
DatasetConfig\CloudStorageBuckets|null

hasExcludeCloudStorageBuckets

setExcludeCloudStorageBuckets

Generated from protobuf field .google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets exclude_cloud_storage_buckets = 11;

Parameter
Name Description
var DatasetConfig\CloudStorageBuckets
Returns
Type Description
$this

getIncludeNewlyCreatedBuckets

If set to true, the request includes all the newly created buckets in the dataset that meet the inclusion and exclusion rules.

Returns
Type Description
bool

setIncludeNewlyCreatedBuckets

If set to true, the request includes all the newly created buckets in the dataset that meet the inclusion and exclusion rules.

Parameter
Name Description
var bool
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var bool
Returns
Type Description
$this

getRetentionPeriodDays

Number of days of history that must be retained.

Returns
Type Description
int

setRetentionPeriodDays

Number of days of history that must be retained.

Parameter
Name Description
var int
Returns
Type Description
$this

getLink

Details of the linked dataset.

Returns
Type Description
DatasetConfig\Link|null

hasLink

clearLink

setLink

Details of the linked dataset.

Parameter
Name Description
var DatasetConfig\Link
Returns
Type Description
$this

getIdentity

Identity used by this datasetConfig.

Returns
Type Description
Identity|null

hasIdentity

clearIdentity

setIdentity

Identity used by this datasetConfig.

Parameter
Name Description
var Identity
Returns
Type Description
$this

getStatus

Output only. Status of the datasetConfig.

Returns
Type Description
Google\Rpc\Status|null

hasStatus

clearStatus

setStatus

Output only. Status of the datasetConfig.

Parameter
Name Description
var Google\Rpc\Status
Returns
Type Description
$this

getDatasetConfigState

Output only. State of the datasetConfig.

Returns
Type Description
int

setDatasetConfigState

Output only. State of the datasetConfig.

Parameter
Name Description
var int
Returns
Type Description
$this

getDescription

Optional. A user-provided description for the dataset configuration.

Maximum length: 256 characters.

Returns
Type Description
string

setDescription

Optional. A user-provided description for the dataset configuration.

Maximum length: 256 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getSourceOptions

Returns
Type Description
string

getCloudStorageLocations

Returns
Type Description
string

getCloudStorageBuckets

Returns
Type Description
string