Google Cloud Storage Insights v1 API - Class DatasetConfig (1.4.0)

public sealed class DatasetConfig : IMessage<DatasetConfig>, IEquatable<DatasetConfig>, IDeepCloneable<DatasetConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Storage Insights v1 API class DatasetConfig.

Message describing the dataset configuration properties. For more information, see Dataset configuration properties.

Inheritance

object > DatasetConfig

Namespace

Google.Cloud.StorageInsights.V1

Assembly

Google.Cloud.StorageInsights.V1.dll

Constructors

DatasetConfig()

public DatasetConfig()

DatasetConfig(DatasetConfig)

public DatasetConfig(DatasetConfig other)
Parameter
Name Description
other DatasetConfig

Properties

CloudStorageBucketsCase

public DatasetConfig.CloudStorageBucketsOneofCase CloudStorageBucketsCase { get; }
Property Value
Type Description
DatasetConfigCloudStorageBucketsOneofCase

CloudStorageLocationsCase

public DatasetConfig.CloudStorageLocationsOneofCase CloudStorageLocationsCase { get; }
Property Value
Type Description
DatasetConfigCloudStorageLocationsOneofCase

CloudStorageObjectPath

public string CloudStorageObjectPath { get; set; }

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}.
Property Value
Type Description
string

CreateTime

public Timestamp CreateTime { get; set; }

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

Property Value
Type Description
Timestamp

DatasetConfigName

public DatasetConfigName DatasetConfigName { get; set; }

DatasetConfigName-typed view over the Name resource name property.

Property Value
Type Description
DatasetConfigName

DatasetConfigState

public DatasetConfig.Types.ConfigState DatasetConfigState { get; set; }

Output only. State of the datasetConfig.

Property Value
Type Description
DatasetConfigTypesConfigState

Description

public string Description { get; set; }

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

Maximum length: 256 characters.

Property Value
Type Description
string

ExcludeCloudStorageBuckets

public DatasetConfig.Types.CloudStorageBuckets ExcludeCloudStorageBuckets { get; set; }
Property Value
Type Description
DatasetConfigTypesCloudStorageBuckets

ExcludeCloudStorageLocations

public DatasetConfig.Types.CloudStorageLocations ExcludeCloudStorageLocations { get; set; }
Property Value
Type Description
DatasetConfigTypesCloudStorageLocations

HasCloudStorageObjectPath

public bool HasCloudStorageObjectPath { get; }

Gets whether the "cloud_storage_object_path" field is set

Property Value
Type Description
bool

HasOrganizationScope

public bool HasOrganizationScope { get; }

Gets whether the "organization_scope" field is set

Property Value
Type Description
bool

Identity

public Identity Identity { get; set; }

Identity used by this datasetConfig.

Property Value
Type Description
Identity

IncludeCloudStorageBuckets

public DatasetConfig.Types.CloudStorageBuckets IncludeCloudStorageBuckets { get; set; }
Property Value
Type Description
DatasetConfigTypesCloudStorageBuckets

IncludeCloudStorageLocations

public DatasetConfig.Types.CloudStorageLocations IncludeCloudStorageLocations { get; set; }
Property Value
Type Description
DatasetConfigTypesCloudStorageLocations

IncludeNewlyCreatedBuckets

public bool IncludeNewlyCreatedBuckets { get; set; }

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

Property Value
Type Description
bool

Labels

public MapField<string, string> Labels { get; }

Labels as key value pairs

Property Value
Type Description
MapFieldstringstring
public DatasetConfig.Types.Link Link { get; set; }

Details of the linked dataset.

Property Value
Type Description
DatasetConfigTypesLink

Name

public string Name { get; set; }

Identifier. name of resource

Property Value
Type Description
string

OrganizationNumber

public long OrganizationNumber { get; set; }

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.

Property Value
Type Description
long

OrganizationScope

public bool OrganizationScope { get; set; }

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

Property Value
Type Description
bool

RetentionPeriodDays

public int RetentionPeriodDays { get; set; }

Number of days of history that must be retained.

Property Value
Type Description
int

SkipVerificationAndIngest

[Obsolete]
public bool SkipVerificationAndIngest { get; set; }

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.

Property Value
Type Description
bool

SourceFolders

public DatasetConfig.Types.SourceFolders SourceFolders { get; set; }

Defines the options for providing source folders for the dataset.

Property Value
Type Description
DatasetConfigTypesSourceFolders

SourceOptionsCase

public DatasetConfig.SourceOptionsOneofCase SourceOptionsCase { get; }
Property Value
Type Description
DatasetConfigSourceOptionsOneofCase

SourceProjects

public DatasetConfig.Types.SourceProjects SourceProjects { get; set; }

Defines the options for providing source projects for the dataset.

Property Value
Type Description
DatasetConfigTypesSourceProjects

Status

public Status Status { get; set; }

Output only. Status of the datasetConfig.

Property Value
Type Description
Status

Uid

public string Uid { get; set; }

Output only. System generated unique identifier for the resource.

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

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

Property Value
Type Description
Timestamp