Interface DatasetConfigOrBuilder (0.48.0) 

public interface DatasetConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Labels as key value pairs

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

getCloudStorageBucketsCase()

public abstract DatasetConfig.CloudStorageBucketsCase getCloudStorageBucketsCase()
Returns
Type Description
DatasetConfig.CloudStorageBucketsCase

getCloudStorageLocationsCase()

public abstract DatasetConfig.CloudStorageLocationsCase getCloudStorageLocationsCase()
Returns
Type Description
DatasetConfig.CloudStorageLocationsCase

getCloudStorageObjectPath()

public abstract String 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}.

string cloud_storage_object_path = 21 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
String

The cloudStorageObjectPath.

getCloudStorageObjectPathBytes()

public abstract ByteString getCloudStorageObjectPathBytes()

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}.

string cloud_storage_object_path = 21 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
ByteString

The bytes for cloudStorageObjectPath.

getCreateTime()

public abstract Timestamp getCreateTime()

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

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

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

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDatasetConfigState()

public abstract DatasetConfig.ConfigState getDatasetConfigState()

Output only. State of the datasetConfig.

.google.cloud.storageinsights.v1.DatasetConfig.ConfigState dataset_config_state = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DatasetConfig.ConfigState

The datasetConfigState.

getDatasetConfigStateValue()

public abstract int getDatasetConfigStateValue()

Output only. State of the datasetConfig.

.google.cloud.storageinsights.v1.DatasetConfig.ConfigState dataset_config_state = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for datasetConfigState.

getDescription()

public abstract String getDescription()

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

Maximum length: 256 characters.

string description = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

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

Maximum length: 256 characters.

string description = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getExcludeCloudStorageBuckets()

public abstract DatasetConfig.CloudStorageBuckets getExcludeCloudStorageBuckets()

.google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets exclude_cloud_storage_buckets = 11;

Returns
Type Description
DatasetConfig.CloudStorageBuckets

The excludeCloudStorageBuckets.

getExcludeCloudStorageBucketsOrBuilder()

public abstract DatasetConfig.CloudStorageBucketsOrBuilder getExcludeCloudStorageBucketsOrBuilder()

.google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets exclude_cloud_storage_buckets = 11;

Returns
Type Description
DatasetConfig.CloudStorageBucketsOrBuilder

getExcludeCloudStorageLocations()

public abstract DatasetConfig.CloudStorageLocations getExcludeCloudStorageLocations()

.google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations exclude_cloud_storage_locations = 9;

Returns
Type Description
DatasetConfig.CloudStorageLocations

The excludeCloudStorageLocations.

getExcludeCloudStorageLocationsOrBuilder()

public abstract DatasetConfig.CloudStorageLocationsOrBuilder getExcludeCloudStorageLocationsOrBuilder()

.google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations exclude_cloud_storage_locations = 9;

Returns
Type Description
DatasetConfig.CloudStorageLocationsOrBuilder

getIdentity()

public abstract Identity getIdentity()

Identity used by this datasetConfig.

.google.cloud.storageinsights.v1.Identity identity = 16;

Returns
Type Description
Identity

The identity.

getIdentityOrBuilder()

public abstract IdentityOrBuilder getIdentityOrBuilder()

Identity used by this datasetConfig.

.google.cloud.storageinsights.v1.Identity identity = 16;

Returns
Type Description
IdentityOrBuilder

getIncludeCloudStorageBuckets()

public abstract DatasetConfig.CloudStorageBuckets getIncludeCloudStorageBuckets()

.google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets include_cloud_storage_buckets = 10;

Returns
Type Description
DatasetConfig.CloudStorageBuckets

The includeCloudStorageBuckets.

getIncludeCloudStorageBucketsOrBuilder()

public abstract DatasetConfig.CloudStorageBucketsOrBuilder getIncludeCloudStorageBucketsOrBuilder()

.google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets include_cloud_storage_buckets = 10;

Returns
Type Description
DatasetConfig.CloudStorageBucketsOrBuilder

getIncludeCloudStorageLocations()

public abstract DatasetConfig.CloudStorageLocations getIncludeCloudStorageLocations()

.google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations include_cloud_storage_locations = 8;

Returns
Type Description
DatasetConfig.CloudStorageLocations

The includeCloudStorageLocations.

getIncludeCloudStorageLocationsOrBuilder()

public abstract DatasetConfig.CloudStorageLocationsOrBuilder getIncludeCloudStorageLocationsOrBuilder()

.google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations include_cloud_storage_locations = 8;

Returns
Type Description
DatasetConfig.CloudStorageLocationsOrBuilder

getIncludeNewlyCreatedBuckets()

public abstract boolean getIncludeNewlyCreatedBuckets()

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

bool include_newly_created_buckets = 12;

Returns
Type Description
boolean

The includeNewlyCreatedBuckets.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Labels as key value pairs

map<string, string> labels = 4;

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Labels as key value pairs

map<string, string> labels = 4;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Labels as key value pairs

map<string, string> labels = 4;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Labels as key value pairs

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
String

getLink()

public abstract DatasetConfig.Link getLink()

Details of the linked dataset.

.google.cloud.storageinsights.v1.DatasetConfig.Link link = 15;

Returns
Type Description
DatasetConfig.Link

The link.

getLinkOrBuilder()

public abstract DatasetConfig.LinkOrBuilder getLinkOrBuilder()

Details of the linked dataset.

.google.cloud.storageinsights.v1.DatasetConfig.Link link = 15;

Returns
Type Description
DatasetConfig.LinkOrBuilder

getName()

public abstract String getName()

Identifier. name of resource

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. name of resource

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getOrganizationNumber()

public abstract long 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.

int64 organization_number = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The organizationNumber.

getOrganizationScope()

public abstract boolean getOrganizationScope()

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

bool organization_scope = 25;

Returns
Type Description
boolean

The organizationScope.

getRetentionPeriodDays()

public abstract int getRetentionPeriodDays()

Number of days of history that must be retained.

int32 retention_period_days = 14;

Returns
Type Description
int

The retentionPeriodDays.

getSkipVerificationAndIngest() (deprecated)

public abstract boolean getSkipVerificationAndIngest()

Deprecated. google.cloud.storageinsights.v1.DatasetConfig.skip_verification_and_ingest is deprecated. See google/cloud/storageinsights/v1/storageinsights.proto;l=848

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 skip_verification_and_ingest = 19 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The skipVerificationAndIngest.

getSourceFolders()

public abstract DatasetConfig.SourceFolders getSourceFolders()

Defines the options for providing source folders for the dataset.

.google.cloud.storageinsights.v1.DatasetConfig.SourceFolders source_folders = 24;

Returns
Type Description
DatasetConfig.SourceFolders

The sourceFolders.

getSourceFoldersOrBuilder()

public abstract DatasetConfig.SourceFoldersOrBuilder getSourceFoldersOrBuilder()

Defines the options for providing source folders for the dataset.

.google.cloud.storageinsights.v1.DatasetConfig.SourceFolders source_folders = 24;

Returns
Type Description
DatasetConfig.SourceFoldersOrBuilder

getSourceOptionsCase()

public abstract DatasetConfig.SourceOptionsCase getSourceOptionsCase()
Returns
Type Description
DatasetConfig.SourceOptionsCase

getSourceProjects()

public abstract DatasetConfig.SourceProjects getSourceProjects()

Defines the options for providing source projects for the dataset.

.google.cloud.storageinsights.v1.DatasetConfig.SourceProjects source_projects = 7;

Returns
Type Description
DatasetConfig.SourceProjects

The sourceProjects.

getSourceProjectsOrBuilder()

public abstract DatasetConfig.SourceProjectsOrBuilder getSourceProjectsOrBuilder()

Defines the options for providing source projects for the dataset.

.google.cloud.storageinsights.v1.DatasetConfig.SourceProjects source_projects = 7;

Returns
Type Description
DatasetConfig.SourceProjectsOrBuilder

getStatus()

public abstract Status getStatus()

Output only. Status of the datasetConfig.

.google.rpc.Status status = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.Status

The status.

getStatusOrBuilder()

public abstract StatusOrBuilder getStatusOrBuilder()

Output only. Status of the datasetConfig.

.google.rpc.Status status = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.StatusOrBuilder

getUid()

public abstract String getUid()

Output only. System generated unique identifier for the resource.

string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uid.

getUidBytes()

public abstract ByteString getUidBytes()

Output only. System generated unique identifier for the resource.

string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public abstract Timestamp getUpdateTime()

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

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

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

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCloudStorageObjectPath()

public abstract boolean hasCloudStorageObjectPath()

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}.

string cloud_storage_object_path = 21 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

Whether the cloudStorageObjectPath field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

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

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasExcludeCloudStorageBuckets()

public abstract boolean hasExcludeCloudStorageBuckets()

.google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets exclude_cloud_storage_buckets = 11;

Returns
Type Description
boolean

Whether the excludeCloudStorageBuckets field is set.

hasExcludeCloudStorageLocations()

public abstract boolean hasExcludeCloudStorageLocations()

.google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations exclude_cloud_storage_locations = 9;

Returns
Type Description
boolean

Whether the excludeCloudStorageLocations field is set.

hasIdentity()

public abstract boolean hasIdentity()

Identity used by this datasetConfig.

.google.cloud.storageinsights.v1.Identity identity = 16;

Returns
Type Description
boolean

Whether the identity field is set.

hasIncludeCloudStorageBuckets()

public abstract boolean hasIncludeCloudStorageBuckets()

.google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets include_cloud_storage_buckets = 10;

Returns
Type Description
boolean

Whether the includeCloudStorageBuckets field is set.

hasIncludeCloudStorageLocations()

public abstract boolean hasIncludeCloudStorageLocations()

.google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations include_cloud_storage_locations = 8;

Returns
Type Description
boolean

Whether the includeCloudStorageLocations field is set.

hasLink()

public abstract boolean hasLink()

Details of the linked dataset.

.google.cloud.storageinsights.v1.DatasetConfig.Link link = 15;

Returns
Type Description
boolean

Whether the link field is set.

hasOrganizationScope()

public abstract boolean hasOrganizationScope()

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

bool organization_scope = 25;

Returns
Type Description
boolean

Whether the organizationScope field is set.

hasSourceFolders()

public abstract boolean hasSourceFolders()

Defines the options for providing source folders for the dataset.

.google.cloud.storageinsights.v1.DatasetConfig.SourceFolders source_folders = 24;

Returns
Type Description
boolean

Whether the sourceFolders field is set.

hasSourceProjects()

public abstract boolean hasSourceProjects()

Defines the options for providing source projects for the dataset.

.google.cloud.storageinsights.v1.DatasetConfig.SourceProjects source_projects = 7;

Returns
Type Description
boolean

Whether the sourceProjects field is set.

hasStatus()

public abstract boolean hasStatus()

Output only. Status of the datasetConfig.

.google.rpc.Status status = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the status field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

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

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.