/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dataplex/v1/data_profile.proto
// Protobuf Java Version: 3.25.4
package com.google.cloud.dataplex.v1;
public interface DataProfileSpecOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dataplex.v1.DataProfileSpec)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Optional. The percentage of the records to be selected from the dataset for
* DataScan.
*
* * Value can range between 0.0 and 100.0 with up to 3 significant decimal
* digits.
* * Sampling is not applied if `sampling_percent` is not specified, 0 or
* 100.
*
*
* float sampling_percent = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The samplingPercent.
*/
float getSamplingPercent();
/**
*
*
*
* Optional. A filter applied to all rows in a single DataScan job.
* The filter needs to be a valid SQL expression for a WHERE clause in
* BigQuery standard SQL syntax.
* Example: col1 >= 0 AND col2 < 10
*
*
* string row_filter = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The rowFilter.
*/
java.lang.String getRowFilter();
/**
*
*
*
* Optional. A filter applied to all rows in a single DataScan job.
* The filter needs to be a valid SQL expression for a WHERE clause in
* BigQuery standard SQL syntax.
* Example: col1 >= 0 AND col2 < 10
*
*
* string row_filter = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for rowFilter.
*/
com.google.protobuf.ByteString getRowFilterBytes();
/**
*
*
*
* Optional. Actions to take upon job completion..
*
*
*
* .google.cloud.dataplex.v1.DataProfileSpec.PostScanActions post_scan_actions = 4 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the postScanActions field is set.
*/
boolean hasPostScanActions();
/**
*
*
*
* Optional. Actions to take upon job completion..
*
*
*
* .google.cloud.dataplex.v1.DataProfileSpec.PostScanActions post_scan_actions = 4 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The postScanActions.
*/
com.google.cloud.dataplex.v1.DataProfileSpec.PostScanActions getPostScanActions();
/**
*
*
*
* Optional. Actions to take upon job completion..
*
*
*
* .google.cloud.dataplex.v1.DataProfileSpec.PostScanActions post_scan_actions = 4 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataplex.v1.DataProfileSpec.PostScanActionsOrBuilder
getPostScanActionsOrBuilder();
/**
*
*
*
* Optional. The fields to include in data profile.
*
* If not specified, all fields at the time of profile scan job execution are
* included, except for ones listed in `exclude_fields`.
*
*
*
* .google.cloud.dataplex.v1.DataProfileSpec.SelectedFields include_fields = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the includeFields field is set.
*/
boolean hasIncludeFields();
/**
*
*
*
* Optional. The fields to include in data profile.
*
* If not specified, all fields at the time of profile scan job execution are
* included, except for ones listed in `exclude_fields`.
*
*
*
* .google.cloud.dataplex.v1.DataProfileSpec.SelectedFields include_fields = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The includeFields.
*/
com.google.cloud.dataplex.v1.DataProfileSpec.SelectedFields getIncludeFields();
/**
*
*
*
* Optional. The fields to include in data profile.
*
* If not specified, all fields at the time of profile scan job execution are
* included, except for ones listed in `exclude_fields`.
*
*
*
* .google.cloud.dataplex.v1.DataProfileSpec.SelectedFields include_fields = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataplex.v1.DataProfileSpec.SelectedFieldsOrBuilder getIncludeFieldsOrBuilder();
/**
*
*
*
* Optional. The fields to exclude from data profile.
*
* If specified, the fields will be excluded from data profile, regardless of
* `include_fields` value.
*
*
*
* .google.cloud.dataplex.v1.DataProfileSpec.SelectedFields exclude_fields = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the excludeFields field is set.
*/
boolean hasExcludeFields();
/**
*
*
*
* Optional. The fields to exclude from data profile.
*
* If specified, the fields will be excluded from data profile, regardless of
* `include_fields` value.
*
*
*
* .google.cloud.dataplex.v1.DataProfileSpec.SelectedFields exclude_fields = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The excludeFields.
*/
com.google.cloud.dataplex.v1.DataProfileSpec.SelectedFields getExcludeFields();
/**
*
*
*
* Optional. The fields to exclude from data profile.
*
* If specified, the fields will be excluded from data profile, regardless of
* `include_fields` value.
*
*
*
* .google.cloud.dataplex.v1.DataProfileSpec.SelectedFields exclude_fields = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataplex.v1.DataProfileSpec.SelectedFieldsOrBuilder getExcludeFieldsOrBuilder();
}
