Class HybridOptions.Builder (3.47.0)

public static final class HybridOptions.Builder extends GeneratedMessageV3.Builder<HybridOptions.Builder> implements HybridOptionsOrBuilder

Configuration to control jobs where the content being inspected is outside of Google Cloud Platform.

Protobuf type google.privacy.dlp.v2.HybridOptions

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllRequiredFindingLabelKeys(Iterable<String> values)

public HybridOptions.Builder addAllRequiredFindingLabelKeys(Iterable<String> values)

These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected.

Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?.

No more than 10 keys can be required.

repeated string required_finding_label_keys = 2;

Parameter
Name Description
values Iterable<String>

The requiredFindingLabelKeys to add.

Returns
Type Description
HybridOptions.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public HybridOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
HybridOptions.Builder
Overrides

addRequiredFindingLabelKeys(String value)

public HybridOptions.Builder addRequiredFindingLabelKeys(String value)

These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected.

Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?.

No more than 10 keys can be required.

repeated string required_finding_label_keys = 2;

Parameter
Name Description
value String

The requiredFindingLabelKeys to add.

Returns
Type Description
HybridOptions.Builder

This builder for chaining.

addRequiredFindingLabelKeysBytes(ByteString value)

public HybridOptions.Builder addRequiredFindingLabelKeysBytes(ByteString value)

These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected.

Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?.

No more than 10 keys can be required.

repeated string required_finding_label_keys = 2;

Parameter
Name Description
value ByteString

The bytes of the requiredFindingLabelKeys to add.

Returns
Type Description
HybridOptions.Builder

This builder for chaining.

build()

public HybridOptions build()
Returns
Type Description
HybridOptions

buildPartial()

public HybridOptions buildPartial()
Returns
Type Description
HybridOptions

clear()

public HybridOptions.Builder clear()
Returns
Type Description
HybridOptions.Builder
Overrides

clearDescription()

public HybridOptions.Builder clearDescription()

A short description of where the data is coming from. Will be stored once in the job. 256 max length.

string description = 1;

Returns
Type Description
HybridOptions.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public HybridOptions.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
HybridOptions.Builder
Overrides

clearLabels()

public HybridOptions.Builder clearLabels()
Returns
Type Description
HybridOptions.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public HybridOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
HybridOptions.Builder
Overrides

clearRequiredFindingLabelKeys()

public HybridOptions.Builder clearRequiredFindingLabelKeys()

These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected.

Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?.

No more than 10 keys can be required.

repeated string required_finding_label_keys = 2;

Returns
Type Description
HybridOptions.Builder

This builder for chaining.

clearTableOptions()

public HybridOptions.Builder clearTableOptions()

If the container is a table, additional information to make findings meaningful such as the columns that are primary keys.

.google.privacy.dlp.v2.TableOptions table_options = 4;

Returns
Type Description
HybridOptions.Builder

clone()

public HybridOptions.Builder clone()
Returns
Type Description
HybridOptions.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

To organize findings, these labels will be added to each finding.

Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?.

Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.

No more than 10 labels can be associated with a given finding.

Examples:

  • "environment" : "production"
  • "pipeline" : "etl"

map<string, string> labels = 3;

Parameter
Name Description
key String
Returns
Type Description
boolean

getDefaultInstanceForType()

public HybridOptions getDefaultInstanceForType()
Returns
Type Description
HybridOptions

getDescription()

public String getDescription()

A short description of where the data is coming from. Will be stored once in the job. 256 max length.

string description = 1;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

A short description of where the data is coming from. Will be stored once in the job. 256 max length.

string description = 1;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

To organize findings, these labels will be added to each finding.

Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?.

Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.

No more than 10 labels can be associated with a given finding.

Examples:

  • "environment" : "production"
  • "pipeline" : "etl"

map<string, string> labels = 3;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

To organize findings, these labels will be added to each finding.

Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?.

Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.

No more than 10 labels can be associated with a given finding.

Examples:

  • "environment" : "production"
  • "pipeline" : "etl"

map<string, string> labels = 3;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

To organize findings, these labels will be added to each finding.

Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?.

Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.

No more than 10 labels can be associated with a given finding.

Examples:

  • "environment" : "production"
  • "pipeline" : "etl"

map<string, string> labels = 3;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

To organize findings, these labels will be added to each finding.

Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?.

Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.

No more than 10 labels can be associated with a given finding.

Examples:

  • "environment" : "production"
  • "pipeline" : "etl"

map<string, string> labels = 3;

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>

getRequiredFindingLabelKeys(int index)

public String getRequiredFindingLabelKeys(int index)

These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected.

Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?.

No more than 10 keys can be required.

repeated string required_finding_label_keys = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The requiredFindingLabelKeys at the given index.

getRequiredFindingLabelKeysBytes(int index)

public ByteString getRequiredFindingLabelKeysBytes(int index)

These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected.

Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?.

No more than 10 keys can be required.

repeated string required_finding_label_keys = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the requiredFindingLabelKeys at the given index.

getRequiredFindingLabelKeysCount()

public int getRequiredFindingLabelKeysCount()

These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected.

Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?.

No more than 10 keys can be required.

repeated string required_finding_label_keys = 2;

Returns
Type Description
int

The count of requiredFindingLabelKeys.

getRequiredFindingLabelKeysList()

public ProtocolStringList getRequiredFindingLabelKeysList()

These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected.

Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?.

No more than 10 keys can be required.

repeated string required_finding_label_keys = 2;

Returns
Type Description
ProtocolStringList

A list containing the requiredFindingLabelKeys.

getTableOptions()

public TableOptions getTableOptions()

If the container is a table, additional information to make findings meaningful such as the columns that are primary keys.

.google.privacy.dlp.v2.TableOptions table_options = 4;

Returns
Type Description
TableOptions

The tableOptions.

getTableOptionsBuilder()

public TableOptions.Builder getTableOptionsBuilder()

If the container is a table, additional information to make findings meaningful such as the columns that are primary keys.

.google.privacy.dlp.v2.TableOptions table_options = 4;

Returns
Type Description
TableOptions.Builder

getTableOptionsOrBuilder()

public TableOptionsOrBuilder getTableOptionsOrBuilder()

If the container is a table, additional information to make findings meaningful such as the columns that are primary keys.

.google.privacy.dlp.v2.TableOptions table_options = 4;

Returns
Type Description
TableOptionsOrBuilder

hasTableOptions()

public boolean hasTableOptions()

If the container is a table, additional information to make findings meaningful such as the columns that are primary keys.

.google.privacy.dlp.v2.TableOptions table_options = 4;

Returns
Type Description
boolean

Whether the tableOptions field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(HybridOptions other)

public HybridOptions.Builder mergeFrom(HybridOptions other)
Parameter
Name Description
other HybridOptions
Returns
Type Description
HybridOptions.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public HybridOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HybridOptions.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public HybridOptions.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
HybridOptions.Builder
Overrides

mergeTableOptions(TableOptions value)

public HybridOptions.Builder mergeTableOptions(TableOptions value)

If the container is a table, additional information to make findings meaningful such as the columns that are primary keys.

.google.privacy.dlp.v2.TableOptions table_options = 4;

Parameter
Name Description
value TableOptions
Returns
Type Description
HybridOptions.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final HybridOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
HybridOptions.Builder
Overrides

putAllLabels(Map<String,String> values)

public HybridOptions.Builder putAllLabels(Map<String,String> values)

To organize findings, these labels will be added to each finding.

Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?.

Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.

No more than 10 labels can be associated with a given finding.

Examples:

  • "environment" : "production"
  • "pipeline" : "etl"

map<string, string> labels = 3;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
HybridOptions.Builder

putLabels(String key, String value)

public HybridOptions.Builder putLabels(String key, String value)

To organize findings, these labels will be added to each finding.

Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?.

Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.

No more than 10 labels can be associated with a given finding.

Examples:

  • "environment" : "production"
  • "pipeline" : "etl"

map<string, string> labels = 3;

Parameters
Name Description
key String
value String
Returns
Type Description
HybridOptions.Builder

removeLabels(String key)

public HybridOptions.Builder removeLabels(String key)

To organize findings, these labels will be added to each finding.

Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?.

Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.

No more than 10 labels can be associated with a given finding.

Examples:

  • "environment" : "production"
  • "pipeline" : "etl"

map<string, string> labels = 3;

Parameter
Name Description
key String
Returns
Type Description
HybridOptions.Builder

setDescription(String value)

public HybridOptions.Builder setDescription(String value)

A short description of where the data is coming from. Will be stored once in the job. 256 max length.

string description = 1;

Parameter
Name Description
value String

The description to set.

Returns
Type Description
HybridOptions.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public HybridOptions.Builder setDescriptionBytes(ByteString value)

A short description of where the data is coming from. Will be stored once in the job. 256 max length.

string description = 1;

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
HybridOptions.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public HybridOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
HybridOptions.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public HybridOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
HybridOptions.Builder
Overrides

setRequiredFindingLabelKeys(int index, String value)

public HybridOptions.Builder setRequiredFindingLabelKeys(int index, String value)

These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected.

Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?.

No more than 10 keys can be required.

repeated string required_finding_label_keys = 2;

Parameters
Name Description
index int

The index to set the value at.

value String

The requiredFindingLabelKeys to set.

Returns
Type Description
HybridOptions.Builder

This builder for chaining.

setTableOptions(TableOptions value)

public HybridOptions.Builder setTableOptions(TableOptions value)

If the container is a table, additional information to make findings meaningful such as the columns that are primary keys.

.google.privacy.dlp.v2.TableOptions table_options = 4;

Parameter
Name Description
value TableOptions
Returns
Type Description
HybridOptions.Builder

setTableOptions(TableOptions.Builder builderForValue)

public HybridOptions.Builder setTableOptions(TableOptions.Builder builderForValue)

If the container is a table, additional information to make findings meaningful such as the columns that are primary keys.

.google.privacy.dlp.v2.TableOptions table_options = 4;

Parameter
Name Description
builderForValue TableOptions.Builder
Returns
Type Description
HybridOptions.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final HybridOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
HybridOptions.Builder
Overrides