Interface DatasetConfigOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
DatasetConfig,DatasetConfig.Builder
@Generated
public interface DatasetConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsLabels(String key) Labels as key value pairsInput only.com.google.protobuf.ByteStringInput only.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Output only.intOutput only.Optional.com.google.protobuf.ByteStringOptional..google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets exclude_cloud_storage_buckets = 11;.google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets exclude_cloud_storage_buckets = 11;.google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations exclude_cloud_storage_locations = 9;.google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations exclude_cloud_storage_locations = 9;Identity used by this `datasetConfig`.Identity used by this `datasetConfig`..google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets include_cloud_storage_buckets = 10;.google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets include_cloud_storage_buckets = 10;.google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations include_cloud_storage_locations = 8;.google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations include_cloud_storage_locations = 8;booleanIf set to `true`, the request includes all the newly created buckets in the dataset that meet the inclusion and exclusion rules.Deprecated.intLabels as key value pairsLabels as key value pairsgetLabelsOrDefault(String key, String defaultValue) Labels as key value pairsgetLabelsOrThrow(String key) Labels as key value pairsgetLink()Details of the linked dataset.Details of the linked dataset.getName()Identifier. name of resourcecom.google.protobuf.ByteStringIdentifier. name of resourcelongOptional.booleanDefines the options for providing a source organization for the dataset.intNumber of days of history that must be retained.booleanDeprecated.google.cloud.storageinsights.v1.DatasetConfig.skip_verification_and_ingest is deprecated.Defines the options for providing source folders for the dataset.Defines the options for providing source folders for the dataset.Defines the options for providing source projects for the dataset.Defines the options for providing source projects for the dataset.Output only.Output only.getUid()Output only.com.google.protobuf.ByteStringOutput only.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.booleanInput only.booleanOutput only.boolean.google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets exclude_cloud_storage_buckets = 11;boolean.google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations exclude_cloud_storage_locations = 9;booleanIdentity used by this `datasetConfig`.boolean.google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets include_cloud_storage_buckets = 10;boolean.google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations include_cloud_storage_locations = 8;booleanhasLink()Details of the linked dataset.booleanDefines the options for providing a source organization for the dataset.booleanDefines the options for providing source folders for the dataset.booleanDefines the options for providing source projects for the dataset.booleanOutput only.booleanOutput only.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getName
String getName()Identifier. name of resource
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()Identifier. name of resource
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];- Returns:
- The bytes for name.
-
hasCreateTime
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:
- Whether the createTime field is set.
-
getCreateTime
com.google.protobuf.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:
- The createTime.
-
getCreateTimeOrBuilder
com.google.protobuf.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]; -
hasUpdateTime
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:
- Whether the updateTime field is set.
-
getUpdateTime
com.google.protobuf.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:
- The updateTime.
-
getUpdateTimeOrBuilder
com.google.protobuf.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]; -
getLabelsCount
int getLabelsCount()Labels as key value pairs
map<string, string> labels = 4; -
containsLabels
Labels as key value pairs
map<string, string> labels = 4; -
getLabels
Deprecated.UsegetLabelsMap()instead. -
getLabelsMap
Labels as key value pairs
map<string, string> labels = 4; -
getLabelsOrDefault
Labels as key value pairs
map<string, string> labels = 4; -
getLabelsOrThrow
Labels as key value pairs
map<string, string> labels = 4; -
getUid
String getUid()Output only. System generated unique identifier for the resource.
string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The uid.
-
getUidBytes
com.google.protobuf.ByteString getUidBytes()Output only. System generated unique identifier for the resource.
string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The bytes for uid.
-
getOrganizationNumber
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:
- The organizationNumber.
-
hasSourceProjects
boolean hasSourceProjects()Defines the options for providing source projects for the dataset.
.google.cloud.storageinsights.v1.DatasetConfig.SourceProjects source_projects = 7;- Returns:
- Whether the sourceProjects field is set.
-
getSourceProjects
DatasetConfig.SourceProjects getSourceProjects()Defines the options for providing source projects for the dataset.
.google.cloud.storageinsights.v1.DatasetConfig.SourceProjects source_projects = 7;- Returns:
- The sourceProjects.
-
getSourceProjectsOrBuilder
DatasetConfig.SourceProjectsOrBuilder getSourceProjectsOrBuilder()Defines the options for providing source projects for the dataset.
.google.cloud.storageinsights.v1.DatasetConfig.SourceProjects source_projects = 7; -
hasSourceFolders
boolean hasSourceFolders()Defines the options for providing source folders for the dataset.
.google.cloud.storageinsights.v1.DatasetConfig.SourceFolders source_folders = 24;- Returns:
- Whether the sourceFolders field is set.
-
getSourceFolders
DatasetConfig.SourceFolders getSourceFolders()Defines the options for providing source folders for the dataset.
.google.cloud.storageinsights.v1.DatasetConfig.SourceFolders source_folders = 24;- Returns:
- The sourceFolders.
-
getSourceFoldersOrBuilder
DatasetConfig.SourceFoldersOrBuilder getSourceFoldersOrBuilder()Defines the options for providing source folders for the dataset.
.google.cloud.storageinsights.v1.DatasetConfig.SourceFolders source_folders = 24; -
hasOrganizationScope
boolean hasOrganizationScope()Defines the options for providing a source organization for the dataset.
bool organization_scope = 25;- Returns:
- Whether the organizationScope field is set.
-
getOrganizationScope
boolean getOrganizationScope()Defines the options for providing a source organization for the dataset.
bool organization_scope = 25;- Returns:
- The organizationScope.
-
hasCloudStorageObjectPath
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:
- Whether the cloudStorageObjectPath field is set.
-
getCloudStorageObjectPath
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:
- The cloudStorageObjectPath.
-
getCloudStorageObjectPathBytes
com.google.protobuf.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:
- The bytes for cloudStorageObjectPath.
-
hasIncludeCloudStorageLocations
boolean hasIncludeCloudStorageLocations().google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations include_cloud_storage_locations = 8;- Returns:
- Whether the includeCloudStorageLocations field is set.
-
getIncludeCloudStorageLocations
DatasetConfig.CloudStorageLocations getIncludeCloudStorageLocations().google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations include_cloud_storage_locations = 8;- Returns:
- The includeCloudStorageLocations.
-
getIncludeCloudStorageLocationsOrBuilder
DatasetConfig.CloudStorageLocationsOrBuilder getIncludeCloudStorageLocationsOrBuilder().google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations include_cloud_storage_locations = 8; -
hasExcludeCloudStorageLocations
boolean hasExcludeCloudStorageLocations().google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations exclude_cloud_storage_locations = 9;- Returns:
- Whether the excludeCloudStorageLocations field is set.
-
getExcludeCloudStorageLocations
DatasetConfig.CloudStorageLocations getExcludeCloudStorageLocations().google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations exclude_cloud_storage_locations = 9;- Returns:
- The excludeCloudStorageLocations.
-
getExcludeCloudStorageLocationsOrBuilder
DatasetConfig.CloudStorageLocationsOrBuilder getExcludeCloudStorageLocationsOrBuilder().google.cloud.storageinsights.v1.DatasetConfig.CloudStorageLocations exclude_cloud_storage_locations = 9; -
hasIncludeCloudStorageBuckets
boolean hasIncludeCloudStorageBuckets().google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets include_cloud_storage_buckets = 10;- Returns:
- Whether the includeCloudStorageBuckets field is set.
-
getIncludeCloudStorageBuckets
DatasetConfig.CloudStorageBuckets getIncludeCloudStorageBuckets().google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets include_cloud_storage_buckets = 10;- Returns:
- The includeCloudStorageBuckets.
-
getIncludeCloudStorageBucketsOrBuilder
DatasetConfig.CloudStorageBucketsOrBuilder getIncludeCloudStorageBucketsOrBuilder().google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets include_cloud_storage_buckets = 10; -
hasExcludeCloudStorageBuckets
boolean hasExcludeCloudStorageBuckets().google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets exclude_cloud_storage_buckets = 11;- Returns:
- Whether the excludeCloudStorageBuckets field is set.
-
getExcludeCloudStorageBuckets
DatasetConfig.CloudStorageBuckets getExcludeCloudStorageBuckets().google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets exclude_cloud_storage_buckets = 11;- Returns:
- The excludeCloudStorageBuckets.
-
getExcludeCloudStorageBucketsOrBuilder
DatasetConfig.CloudStorageBucketsOrBuilder getExcludeCloudStorageBucketsOrBuilder().google.cloud.storageinsights.v1.DatasetConfig.CloudStorageBuckets exclude_cloud_storage_buckets = 11; -
getIncludeNewlyCreatedBuckets
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:
- The includeNewlyCreatedBuckets.
-
getSkipVerificationAndIngest
Deprecated.google.cloud.storageinsights.v1.DatasetConfig.skip_verification_and_ingest is deprecated. See google/cloud/storageinsights/v1/storageinsights.proto;l=848Optional. 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:
- The skipVerificationAndIngest.
-
getRetentionPeriodDays
int getRetentionPeriodDays()Number of days of history that must be retained.
int32 retention_period_days = 14;- Returns:
- The retentionPeriodDays.
-
hasLink
boolean hasLink()Details of the linked dataset.
.google.cloud.storageinsights.v1.DatasetConfig.Link link = 15;- Returns:
- Whether the link field is set.
-
getLink
DatasetConfig.Link getLink()Details of the linked dataset.
.google.cloud.storageinsights.v1.DatasetConfig.Link link = 15;- Returns:
- The link.
-
getLinkOrBuilder
DatasetConfig.LinkOrBuilder getLinkOrBuilder()Details of the linked dataset.
.google.cloud.storageinsights.v1.DatasetConfig.Link link = 15; -
hasIdentity
boolean hasIdentity()Identity used by this `datasetConfig`.
.google.cloud.storageinsights.v1.Identity identity = 16;- Returns:
- Whether the identity field is set.
-
getIdentity
Identity getIdentity()Identity used by this `datasetConfig`.
.google.cloud.storageinsights.v1.Identity identity = 16;- Returns:
- The identity.
-
getIdentityOrBuilder
IdentityOrBuilder getIdentityOrBuilder()Identity used by this `datasetConfig`.
.google.cloud.storageinsights.v1.Identity identity = 16; -
hasStatus
boolean hasStatus()Output only. Status of the `datasetConfig`.
.google.rpc.Status status = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the status field is set.
-
getStatus
Status getStatus()Output only. Status of the `datasetConfig`.
.google.rpc.Status status = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The status.
-
getStatusOrBuilder
StatusOrBuilder getStatusOrBuilder()Output only. Status of the `datasetConfig`.
.google.rpc.Status status = 17 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getDatasetConfigStateValue
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:
- The enum numeric value on the wire for datasetConfigState.
-
getDatasetConfigState
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:
- The datasetConfigState.
-
getDescription
String getDescription()Optional. A user-provided description for the dataset configuration. Maximum length: 256 characters.
string description = 20 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The description.
-
getDescriptionBytes
com.google.protobuf.ByteString getDescriptionBytes()Optional. A user-provided description for the dataset configuration. Maximum length: 256 characters.
string description = 20 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The bytes for description.
-
getSourceOptionsCase
DatasetConfig.SourceOptionsCase getSourceOptionsCase() -
getCloudStorageLocationsCase
DatasetConfig.CloudStorageLocationsCase getCloudStorageLocationsCase() -
getCloudStorageBucketsCase
DatasetConfig.CloudStorageBucketsCase getCloudStorageBucketsCase()
-