- 1.51.0 (latest)
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.2
- 1.0.1
- 0.2.2
public static final class DataScan.Builder extends GeneratedMessageV3.Builder<DataScan.Builder> implements DataScanOrBuilder
Represents a user-visible job which provides the insights for the related data source.
For example:
- Data Quality: generates queries based on the rules and runs against the data to get data quality check results.
- Data Profile: analyzes the data in table(s) and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc).
Protobuf type google.cloud.dataplex.v1.DataScan
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DataScan.BuilderImplements
DataScanOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public DataScan.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
build()
public DataScan build()
Returns | |
---|---|
Type | Description |
DataScan |
buildPartial()
public DataScan buildPartial()
Returns | |
---|---|
Type | Description |
DataScan |
clear()
public DataScan.Builder clear()
Returns | |
---|---|
Type | Description |
DataScan.Builder |
clearCreateTime()
public DataScan.Builder clearCreateTime()
Output only. The time when the scan was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
DataScan.Builder |
clearData()
public DataScan.Builder clearData()
Required. The data source for DataScan.
.google.cloud.dataplex.v1.DataSource data = 9 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
DataScan.Builder |
clearDataProfileResult()
public DataScan.Builder clearDataProfileResult()
Output only. The result of the data profile scan.
.google.cloud.dataplex.v1.DataProfileResult data_profile_result = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
DataScan.Builder |
clearDataProfileSpec()
public DataScan.Builder clearDataProfileSpec()
DataProfileScan related setting.
.google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;
Returns | |
---|---|
Type | Description |
DataScan.Builder |
clearDataQualityResult()
public DataScan.Builder clearDataQualityResult()
Output only. The result of the data quality scan.
.google.cloud.dataplex.v1.DataQualityResult data_quality_result = 200 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
DataScan.Builder |
clearDataQualitySpec()
public DataScan.Builder clearDataQualitySpec()
DataQualityScan related setting.
.google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;
Returns | |
---|---|
Type | Description |
DataScan.Builder |
clearDescription()
public DataScan.Builder clearDescription()
Optional. Description of the scan.
- Must be between 1-1024 characters.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
DataScan.Builder | This builder for chaining. |
clearDisplayName()
public DataScan.Builder clearDisplayName()
Optional. User friendly display name.
- Must be between 1-256 characters.
string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
DataScan.Builder | This builder for chaining. |
clearExecutionSpec()
public DataScan.Builder clearExecutionSpec()
Optional. DataScan execution settings.
If not specified, the fields in it will use their default values.
.google.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
DataScan.Builder |
clearExecutionStatus()
public DataScan.Builder clearExecutionStatus()
Output only. Status of the data scan execution.
.google.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
DataScan.Builder |
clearField(Descriptors.FieldDescriptor field)
public DataScan.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
clearLabels()
public DataScan.Builder clearLabels()
Returns | |
---|---|
Type | Description |
DataScan.Builder |
clearName()
public DataScan.Builder clearName()
Output only. The relative resource name of the scan, of the form:
projects/{project}/locations/{location_id}/dataScans/{datascan_id}
,
where project
refers to a project_id or project_number and
location_id
refers to a GCP region.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
DataScan.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public DataScan.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
clearResult()
public DataScan.Builder clearResult()
Returns | |
---|---|
Type | Description |
DataScan.Builder |
clearSpec()
public DataScan.Builder clearSpec()
Returns | |
---|---|
Type | Description |
DataScan.Builder |
clearState()
public DataScan.Builder clearState()
Output only. Current state of the DataScan.
.google.cloud.dataplex.v1.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
DataScan.Builder | This builder for chaining. |
clearType()
public DataScan.Builder clearType()
Output only. The type of DataScan.
.google.cloud.dataplex.v1.DataScanType type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
DataScan.Builder | This builder for chaining. |
clearUid()
public DataScan.Builder clearUid()
Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
DataScan.Builder | This builder for chaining. |
clearUpdateTime()
public DataScan.Builder clearUpdateTime()
Output only. The time when the scan was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
DataScan.Builder |
clone()
public DataScan.Builder clone()
Returns | |
---|---|
Type | Description |
DataScan.Builder |
containsLabels(String key)
public boolean containsLabels(String key)
Optional. User-defined labels for the scan.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
key | String |
Returns | |
---|---|
Type | Description |
boolean |
getCreateTime()
public Timestamp getCreateTime()
Output only. The time when the scan was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp | The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()
Output only. The time when the scan was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time when the scan was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getData()
public DataSource getData()
Required. The data source for DataScan.
.google.cloud.dataplex.v1.DataSource data = 9 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
DataSource | The data. |
getDataBuilder()
public DataSource.Builder getDataBuilder()
Required. The data source for DataScan.
.google.cloud.dataplex.v1.DataSource data = 9 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
DataSource.Builder |
getDataOrBuilder()
public DataSourceOrBuilder getDataOrBuilder()
Required. The data source for DataScan.
.google.cloud.dataplex.v1.DataSource data = 9 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
DataSourceOrBuilder |
getDataProfileResult()
public DataProfileResult getDataProfileResult()
Output only. The result of the data profile scan.
.google.cloud.dataplex.v1.DataProfileResult data_profile_result = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
DataProfileResult | The dataProfileResult. |
getDataProfileResultBuilder()
public DataProfileResult.Builder getDataProfileResultBuilder()
Output only. The result of the data profile scan.
.google.cloud.dataplex.v1.DataProfileResult data_profile_result = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
DataProfileResult.Builder |
getDataProfileResultOrBuilder()
public DataProfileResultOrBuilder getDataProfileResultOrBuilder()
Output only. The result of the data profile scan.
.google.cloud.dataplex.v1.DataProfileResult data_profile_result = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
DataProfileResultOrBuilder |
getDataProfileSpec()
public DataProfileSpec getDataProfileSpec()
DataProfileScan related setting.
.google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;
Returns | |
---|---|
Type | Description |
DataProfileSpec | The dataProfileSpec. |
getDataProfileSpecBuilder()
public DataProfileSpec.Builder getDataProfileSpecBuilder()
DataProfileScan related setting.
.google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;
Returns | |
---|---|
Type | Description |
DataProfileSpec.Builder |
getDataProfileSpecOrBuilder()
public DataProfileSpecOrBuilder getDataProfileSpecOrBuilder()
DataProfileScan related setting.
.google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;
Returns | |
---|---|
Type | Description |
DataProfileSpecOrBuilder |
getDataQualityResult()
public DataQualityResult getDataQualityResult()
Output only. The result of the data quality scan.
.google.cloud.dataplex.v1.DataQualityResult data_quality_result = 200 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
DataQualityResult | The dataQualityResult. |
getDataQualityResultBuilder()
public DataQualityResult.Builder getDataQualityResultBuilder()
Output only. The result of the data quality scan.
.google.cloud.dataplex.v1.DataQualityResult data_quality_result = 200 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
DataQualityResult.Builder |
getDataQualityResultOrBuilder()
public DataQualityResultOrBuilder getDataQualityResultOrBuilder()
Output only. The result of the data quality scan.
.google.cloud.dataplex.v1.DataQualityResult data_quality_result = 200 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
DataQualityResultOrBuilder |
getDataQualitySpec()
public DataQualitySpec getDataQualitySpec()
DataQualityScan related setting.
.google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;
Returns | |
---|---|
Type | Description |
DataQualitySpec | The dataQualitySpec. |
getDataQualitySpecBuilder()
public DataQualitySpec.Builder getDataQualitySpecBuilder()
DataQualityScan related setting.
.google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;
Returns | |
---|---|
Type | Description |
DataQualitySpec.Builder |
getDataQualitySpecOrBuilder()
public DataQualitySpecOrBuilder getDataQualitySpecOrBuilder()
DataQualityScan related setting.
.google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;
Returns | |
---|---|
Type | Description |
DataQualitySpecOrBuilder |
getDefaultInstanceForType()
public DataScan getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
DataScan |
getDescription()
public String getDescription()
Optional. Description of the scan.
- Must be between 1-1024 characters.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String | The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. Description of the scan.
- Must be between 1-1024 characters.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getDisplayName()
public String getDisplayName()
Optional. User friendly display name.
- Must be between 1-256 characters.
string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String | The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Optional. User friendly display name.
- Must be between 1-256 characters.
string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for displayName. |
getExecutionSpec()
public DataScan.ExecutionSpec getExecutionSpec()
Optional. DataScan execution settings.
If not specified, the fields in it will use their default values.
.google.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
DataScan.ExecutionSpec | The executionSpec. |
getExecutionSpecBuilder()
public DataScan.ExecutionSpec.Builder getExecutionSpecBuilder()
Optional. DataScan execution settings.
If not specified, the fields in it will use their default values.
.google.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
DataScan.ExecutionSpec.Builder |
getExecutionSpecOrBuilder()
public DataScan.ExecutionSpecOrBuilder getExecutionSpecOrBuilder()
Optional. DataScan execution settings.
If not specified, the fields in it will use their default values.
.google.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
DataScan.ExecutionSpecOrBuilder |
getExecutionStatus()
public DataScan.ExecutionStatus getExecutionStatus()
Output only. Status of the data scan execution.
.google.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
DataScan.ExecutionStatus | The executionStatus. |
getExecutionStatusBuilder()
public DataScan.ExecutionStatus.Builder getExecutionStatusBuilder()
Output only. Status of the data scan execution.
.google.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
DataScan.ExecutionStatus.Builder |
getExecutionStatusOrBuilder()
public DataScan.ExecutionStatusOrBuilder getExecutionStatusOrBuilder()
Output only. Status of the data scan execution.
.google.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
DataScan.ExecutionStatusOrBuilder |
getLabels() (deprecated)
public Map<String,String> getLabels()
Use #getLabelsMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getLabelsCount()
public int getLabelsCount()
Optional. User-defined labels for the scan.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
getLabelsMap()
public Map<String,String> getLabelsMap()
Optional. User-defined labels for the scan.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Map<String,String> |
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Optional. User-defined labels for the scan.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
key | String |
defaultValue | String |
Returns | |
---|---|
Type | Description |
String |
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Optional. User-defined labels for the scan.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
key | String |
Returns | |
---|---|
Type | Description |
String |
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()
Use alternate mutation accessors instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getName()
public String getName()
Output only. The relative resource name of the scan, of the form:
projects/{project}/locations/{location_id}/dataScans/{datascan_id}
,
where project
refers to a project_id or project_number and
location_id
refers to a GCP region.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes()
Output only. The relative resource name of the scan, of the form:
projects/{project}/locations/{location_id}/dataScans/{datascan_id}
,
where project
refers to a project_id or project_number and
location_id
refers to a GCP region.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for name. |
getResultCase()
public DataScan.ResultCase getResultCase()
Returns | |
---|---|
Type | Description |
DataScan.ResultCase |
getSpecCase()
public DataScan.SpecCase getSpecCase()
Returns | |
---|---|
Type | Description |
DataScan.SpecCase |
getState()
public State getState()
Output only. Current state of the DataScan.
.google.cloud.dataplex.v1.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
State | The state. |
getStateValue()
public int getStateValue()
Output only. Current state of the DataScan.
.google.cloud.dataplex.v1.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
int | The enum numeric value on the wire for state. |
getType()
public DataScanType getType()
Output only. The type of DataScan.
.google.cloud.dataplex.v1.DataScanType type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
DataScanType | The type. |
getTypeValue()
public int getTypeValue()
Output only. The type of DataScan.
.google.cloud.dataplex.v1.DataScanType type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
int | The enum numeric value on the wire for type. |
getUid()
public String getUid()
Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
String | The uid. |
getUidBytes()
public ByteString getUidBytes()
Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for uid. |
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The time when the scan was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp | The updateTime. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()
Output only. The time when the scan was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The time when the scan was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
hasCreateTime()
public boolean hasCreateTime()
Output only. The time when the scan was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean | Whether the createTime field is set. |
hasData()
public boolean hasData()
Required. The data source for DataScan.
.google.cloud.dataplex.v1.DataSource data = 9 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
boolean | Whether the data field is set. |
hasDataProfileResult()
public boolean hasDataProfileResult()
Output only. The result of the data profile scan.
.google.cloud.dataplex.v1.DataProfileResult data_profile_result = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean | Whether the dataProfileResult field is set. |
hasDataProfileSpec()
public boolean hasDataProfileSpec()
DataProfileScan related setting.
.google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;
Returns | |
---|---|
Type | Description |
boolean | Whether the dataProfileSpec field is set. |
hasDataQualityResult()
public boolean hasDataQualityResult()
Output only. The result of the data quality scan.
.google.cloud.dataplex.v1.DataQualityResult data_quality_result = 200 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean | Whether the dataQualityResult field is set. |
hasDataQualitySpec()
public boolean hasDataQualitySpec()
DataQualityScan related setting.
.google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;
Returns | |
---|---|
Type | Description |
boolean | Whether the dataQualitySpec field is set. |
hasExecutionSpec()
public boolean hasExecutionSpec()
Optional. DataScan execution settings.
If not specified, the fields in it will use their default values.
.google.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean | Whether the executionSpec field is set. |
hasExecutionStatus()
public boolean hasExecutionStatus()
Output only. Status of the data scan execution.
.google.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean | Whether the executionStatus field is set. |
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The time when the scan was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean | Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number | int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number | int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeCreateTime(Timestamp value)
public DataScan.Builder mergeCreateTime(Timestamp value)
Output only. The time when the scan was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
mergeData(DataSource value)
public DataScan.Builder mergeData(DataSource value)
Required. The data source for DataScan.
.google.cloud.dataplex.v1.DataSource data = 9 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value | DataSource |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
mergeDataProfileResult(DataProfileResult value)
public DataScan.Builder mergeDataProfileResult(DataProfileResult value)
Output only. The result of the data profile scan.
.google.cloud.dataplex.v1.DataProfileResult data_profile_result = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | DataProfileResult |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
mergeDataProfileSpec(DataProfileSpec value)
public DataScan.Builder mergeDataProfileSpec(DataProfileSpec value)
DataProfileScan related setting.
.google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;
Parameter | |
---|---|
Name | Description |
value | DataProfileSpec |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
mergeDataQualityResult(DataQualityResult value)
public DataScan.Builder mergeDataQualityResult(DataQualityResult value)
Output only. The result of the data quality scan.
.google.cloud.dataplex.v1.DataQualityResult data_quality_result = 200 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | DataQualityResult |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
mergeDataQualitySpec(DataQualitySpec value)
public DataScan.Builder mergeDataQualitySpec(DataQualitySpec value)
DataQualityScan related setting.
.google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;
Parameter | |
---|---|
Name | Description |
value | DataQualitySpec |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
mergeExecutionSpec(DataScan.ExecutionSpec value)
public DataScan.Builder mergeExecutionSpec(DataScan.ExecutionSpec value)
Optional. DataScan execution settings.
If not specified, the fields in it will use their default values.
.google.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | DataScan.ExecutionSpec |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
mergeExecutionStatus(DataScan.ExecutionStatus value)
public DataScan.Builder mergeExecutionStatus(DataScan.ExecutionStatus value)
Output only. Status of the data scan execution.
.google.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | DataScan.ExecutionStatus |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
mergeFrom(DataScan other)
public DataScan.Builder mergeFrom(DataScan other)
Parameter | |
---|---|
Name | Description |
other | DataScan |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public DataScan.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public DataScan.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final DataScan.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
mergeUpdateTime(Timestamp value)
public DataScan.Builder mergeUpdateTime(Timestamp value)
Output only. The time when the scan was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
putAllLabels(Map<String,String> values)
public DataScan.Builder putAllLabels(Map<String,String> values)
Optional. User-defined labels for the scan.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values | Map<String,String> |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
putLabels(String key, String value)
public DataScan.Builder putLabels(String key, String value)
Optional. User-defined labels for the scan.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
key | String |
value | String |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
removeLabels(String key)
public DataScan.Builder removeLabels(String key)
Optional. User-defined labels for the scan.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
key | String |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
setCreateTime(Timestamp value)
public DataScan.Builder setCreateTime(Timestamp value)
Output only. The time when the scan was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
setCreateTime(Timestamp.Builder builderForValue)
public DataScan.Builder setCreateTime(Timestamp.Builder builderForValue)
Output only. The time when the scan was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue | Builder |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
setData(DataSource value)
public DataScan.Builder setData(DataSource value)
Required. The data source for DataScan.
.google.cloud.dataplex.v1.DataSource data = 9 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value | DataSource |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
setData(DataSource.Builder builderForValue)
public DataScan.Builder setData(DataSource.Builder builderForValue)
Required. The data source for DataScan.
.google.cloud.dataplex.v1.DataSource data = 9 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
builderForValue | DataSource.Builder |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
setDataProfileResult(DataProfileResult value)
public DataScan.Builder setDataProfileResult(DataProfileResult value)
Output only. The result of the data profile scan.
.google.cloud.dataplex.v1.DataProfileResult data_profile_result = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | DataProfileResult |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
setDataProfileResult(DataProfileResult.Builder builderForValue)
public DataScan.Builder setDataProfileResult(DataProfileResult.Builder builderForValue)
Output only. The result of the data profile scan.
.google.cloud.dataplex.v1.DataProfileResult data_profile_result = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue | DataProfileResult.Builder |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
setDataProfileSpec(DataProfileSpec value)
public DataScan.Builder setDataProfileSpec(DataProfileSpec value)
DataProfileScan related setting.
.google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;
Parameter | |
---|---|
Name | Description |
value | DataProfileSpec |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
setDataProfileSpec(DataProfileSpec.Builder builderForValue)
public DataScan.Builder setDataProfileSpec(DataProfileSpec.Builder builderForValue)
DataProfileScan related setting.
.google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;
Parameter | |
---|---|
Name | Description |
builderForValue | DataProfileSpec.Builder |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
setDataQualityResult(DataQualityResult value)
public DataScan.Builder setDataQualityResult(DataQualityResult value)
Output only. The result of the data quality scan.
.google.cloud.dataplex.v1.DataQualityResult data_quality_result = 200 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | DataQualityResult |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
setDataQualityResult(DataQualityResult.Builder builderForValue)
public DataScan.Builder setDataQualityResult(DataQualityResult.Builder builderForValue)
Output only. The result of the data quality scan.
.google.cloud.dataplex.v1.DataQualityResult data_quality_result = 200 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue | DataQualityResult.Builder |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
setDataQualitySpec(DataQualitySpec value)
public DataScan.Builder setDataQualitySpec(DataQualitySpec value)
DataQualityScan related setting.
.google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;
Parameter | |
---|---|
Name | Description |
value | DataQualitySpec |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
setDataQualitySpec(DataQualitySpec.Builder builderForValue)
public DataScan.Builder setDataQualitySpec(DataQualitySpec.Builder builderForValue)
DataQualityScan related setting.
.google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;
Parameter | |
---|---|
Name | Description |
builderForValue | DataQualitySpec.Builder |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
setDescription(String value)
public DataScan.Builder setDescription(String value)
Optional. Description of the scan.
- Must be between 1-1024 characters.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | String The description to set. |
Returns | |
---|---|
Type | Description |
DataScan.Builder | This builder for chaining. |
setDescriptionBytes(ByteString value)
public DataScan.Builder setDescriptionBytes(ByteString value)
Optional. Description of the scan.
- Must be between 1-1024 characters.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for description to set. |
Returns | |
---|---|
Type | Description |
DataScan.Builder | This builder for chaining. |
setDisplayName(String value)
public DataScan.Builder setDisplayName(String value)
Optional. User friendly display name.
- Must be between 1-256 characters.
string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | String The displayName to set. |
Returns | |
---|---|
Type | Description |
DataScan.Builder | This builder for chaining. |
setDisplayNameBytes(ByteString value)
public DataScan.Builder setDisplayNameBytes(ByteString value)
Optional. User friendly display name.
- Must be between 1-256 characters.
string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for displayName to set. |
Returns | |
---|---|
Type | Description |
DataScan.Builder | This builder for chaining. |
setExecutionSpec(DataScan.ExecutionSpec value)
public DataScan.Builder setExecutionSpec(DataScan.ExecutionSpec value)
Optional. DataScan execution settings.
If not specified, the fields in it will use their default values.
.google.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | DataScan.ExecutionSpec |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
setExecutionSpec(DataScan.ExecutionSpec.Builder builderForValue)
public DataScan.Builder setExecutionSpec(DataScan.ExecutionSpec.Builder builderForValue)
Optional. DataScan execution settings.
If not specified, the fields in it will use their default values.
.google.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue | DataScan.ExecutionSpec.Builder |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
setExecutionStatus(DataScan.ExecutionStatus value)
public DataScan.Builder setExecutionStatus(DataScan.ExecutionStatus value)
Output only. Status of the data scan execution.
.google.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | DataScan.ExecutionStatus |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
setExecutionStatus(DataScan.ExecutionStatus.Builder builderForValue)
public DataScan.Builder setExecutionStatus(DataScan.ExecutionStatus.Builder builderForValue)
Output only. Status of the data scan execution.
.google.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue | DataScan.ExecutionStatus.Builder |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public DataScan.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
setName(String value)
public DataScan.Builder setName(String value)
Output only. The relative resource name of the scan, of the form:
projects/{project}/locations/{location_id}/dataScans/{datascan_id}
,
where project
refers to a project_id or project_number and
location_id
refers to a GCP region.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | String The name to set. |
Returns | |
---|---|
Type | Description |
DataScan.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public DataScan.Builder setNameBytes(ByteString value)
Output only. The relative resource name of the scan, of the form:
projects/{project}/locations/{location_id}/dataScans/{datascan_id}
,
where project
refers to a project_id or project_number and
location_id
refers to a GCP region.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
DataScan.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public DataScan.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
setState(State value)
public DataScan.Builder setState(State value)
Output only. Current state of the DataScan.
.google.cloud.dataplex.v1.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | State The state to set. |
Returns | |
---|---|
Type | Description |
DataScan.Builder | This builder for chaining. |
setStateValue(int value)
public DataScan.Builder setStateValue(int value)
Output only. Current state of the DataScan.
.google.cloud.dataplex.v1.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | int The enum numeric value on the wire for state to set. |
Returns | |
---|---|
Type | Description |
DataScan.Builder | This builder for chaining. |
setType(DataScanType value)
public DataScan.Builder setType(DataScanType value)
Output only. The type of DataScan.
.google.cloud.dataplex.v1.DataScanType type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | DataScanType The type to set. |
Returns | |
---|---|
Type | Description |
DataScan.Builder | This builder for chaining. |
setTypeValue(int value)
public DataScan.Builder setTypeValue(int value)
Output only. The type of DataScan.
.google.cloud.dataplex.v1.DataScanType type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | int The enum numeric value on the wire for type to set. |
Returns | |
---|---|
Type | Description |
DataScan.Builder | This builder for chaining. |
setUid(String value)
public DataScan.Builder setUid(String value)
Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | String The uid to set. |
Returns | |
---|---|
Type | Description |
DataScan.Builder | This builder for chaining. |
setUidBytes(ByteString value)
public DataScan.Builder setUidBytes(ByteString value)
Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for uid to set. |
Returns | |
---|---|
Type | Description |
DataScan.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final DataScan.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
setUpdateTime(Timestamp value)
public DataScan.Builder setUpdateTime(Timestamp value)
Output only. The time when the scan was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
DataScan.Builder |
setUpdateTime(Timestamp.Builder builderForValue)
public DataScan.Builder setUpdateTime(Timestamp.Builder builderForValue)
Output only. The time when the scan was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue | Builder |
Returns | |
---|---|
Type | Description |
DataScan.Builder |