Represents a DatasetConfig.
Package
@google-cloud/storageinsightsConstructors
(constructor)(properties)
constructor(properties?: google.cloud.storageinsights.v1.IDatasetConfig);Constructs a new DatasetConfig.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDatasetConfig
Properties to set |
Properties
cloudStorageBuckets
public cloudStorageBuckets?: ("includeCloudStorageBuckets"|"excludeCloudStorageBuckets");DatasetConfig cloudStorageBuckets.
cloudStorageLocations
public cloudStorageLocations?: ("includeCloudStorageLocations"|"excludeCloudStorageLocations");DatasetConfig cloudStorageLocations.
cloudStorageObjectPath
public cloudStorageObjectPath?: (string|null);DatasetConfig cloudStorageObjectPath.
createTime
public createTime?: (google.protobuf.ITimestamp|null);DatasetConfig createTime.
datasetConfigState
public datasetConfigState: (google.cloud.storageinsights.v1.DatasetConfig.ConfigState|keyof typeof google.cloud.storageinsights.v1.DatasetConfig.ConfigState);DatasetConfig datasetConfigState.
description
public description: string;DatasetConfig description.
excludeCloudStorageBuckets
public excludeCloudStorageBuckets?: (google.cloud.storageinsights.v1.DatasetConfig.ICloudStorageBuckets|null);DatasetConfig excludeCloudStorageBuckets.
excludeCloudStorageLocations
public excludeCloudStorageLocations?: (google.cloud.storageinsights.v1.DatasetConfig.ICloudStorageLocations|null);DatasetConfig excludeCloudStorageLocations.
identity
public identity?: (google.cloud.storageinsights.v1.IIdentity|null);DatasetConfig identity.
includeCloudStorageBuckets
public includeCloudStorageBuckets?: (google.cloud.storageinsights.v1.DatasetConfig.ICloudStorageBuckets|null);DatasetConfig includeCloudStorageBuckets.
includeCloudStorageLocations
public includeCloudStorageLocations?: (google.cloud.storageinsights.v1.DatasetConfig.ICloudStorageLocations|null);DatasetConfig includeCloudStorageLocations.
includeNewlyCreatedBuckets
public includeNewlyCreatedBuckets: boolean;DatasetConfig includeNewlyCreatedBuckets.
labels
public labels: { [k: string]: string };DatasetConfig labels.
link
public link?: (google.cloud.storageinsights.v1.DatasetConfig.ILink|null);DatasetConfig link.
name
public name: string;DatasetConfig name.
organizationNumber
public organizationNumber: (number|Long|string);DatasetConfig organizationNumber.
organizationScope
public organizationScope?: (boolean|null);DatasetConfig organizationScope.
retentionPeriodDays
public retentionPeriodDays: number;DatasetConfig retentionPeriodDays.
skipVerificationAndIngest
public skipVerificationAndIngest: boolean;DatasetConfig skipVerificationAndIngest.
sourceFolders
public sourceFolders?: (google.cloud.storageinsights.v1.DatasetConfig.ISourceFolders|null);DatasetConfig sourceFolders.
sourceOptions
public sourceOptions?: ("sourceProjects"|"sourceFolders"|"organizationScope"|"cloudStorageObjectPath");DatasetConfig sourceOptions.
sourceProjects
public sourceProjects?: (google.cloud.storageinsights.v1.DatasetConfig.ISourceProjects|null);DatasetConfig sourceProjects.
status
public status?: (google.rpc.IStatus|null);DatasetConfig status.
uid
public uid: string;DatasetConfig uid.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);DatasetConfig updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.storageinsights.v1.IDatasetConfig): google.cloud.storageinsights.v1.DatasetConfig;Creates a new DatasetConfig instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDatasetConfig
Properties to set |
| Returns | |
|---|---|
| Type | Description |
DatasetConfig |
DatasetConfig instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.storageinsights.v1.DatasetConfig;Decodes a DatasetConfig message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
DatasetConfig |
DatasetConfig |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.storageinsights.v1.DatasetConfig;Decodes a DatasetConfig message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
DatasetConfig |
DatasetConfig |
encode(message, writer)
public static encode(message: google.cloud.storageinsights.v1.IDatasetConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified DatasetConfig message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDatasetConfig
DatasetConfig message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.storageinsights.v1.IDatasetConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified DatasetConfig message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDatasetConfig
DatasetConfig message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.storageinsights.v1.DatasetConfig;Creates a DatasetConfig message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
DatasetConfig |
DatasetConfig |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for DatasetConfig
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this DatasetConfig to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.storageinsights.v1.DatasetConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a DatasetConfig message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
DatasetConfig
DatasetConfig |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a DatasetConfig message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|