Class DataRedactionSettings.Builder (0.45.0)

public static final class DataRedactionSettings.Builder extends GeneratedMessageV3.Builder<DataRedactionSettings.Builder> implements DataRedactionSettingsOrBuilder

Settings for client-side data redaction. Singleton resource under a Web Stream.

Protobuf type google.analytics.admin.v1alpha.DataRedactionSettings

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllQueryParameterKeys(Iterable<String> values)

public DataRedactionSettings.Builder addAllQueryParameterKeys(Iterable<String> values)

The query parameter keys to apply redaction logic to if present in the URL. Query parameter matching is case-insensitive.

Must contain at least one element if query_parameter_replacement_enabled is true. Keys cannot contain commas.

repeated string query_parameter_keys = 4;

Parameter
NameDescription
valuesIterable<String>

The queryParameterKeys to add.

Returns
TypeDescription
DataRedactionSettings.Builder

This builder for chaining.

addQueryParameterKeys(String value)

public DataRedactionSettings.Builder addQueryParameterKeys(String value)

The query parameter keys to apply redaction logic to if present in the URL. Query parameter matching is case-insensitive.

Must contain at least one element if query_parameter_replacement_enabled is true. Keys cannot contain commas.

repeated string query_parameter_keys = 4;

Parameter
NameDescription
valueString

The queryParameterKeys to add.

Returns
TypeDescription
DataRedactionSettings.Builder

This builder for chaining.

addQueryParameterKeysBytes(ByteString value)

public DataRedactionSettings.Builder addQueryParameterKeysBytes(ByteString value)

The query parameter keys to apply redaction logic to if present in the URL. Query parameter matching is case-insensitive.

Must contain at least one element if query_parameter_replacement_enabled is true. Keys cannot contain commas.

repeated string query_parameter_keys = 4;

Parameter
NameDescription
valueByteString

The bytes of the queryParameterKeys to add.

Returns
TypeDescription
DataRedactionSettings.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DataRedactionSettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DataRedactionSettings.Builder
Overrides

build()

public DataRedactionSettings build()
Returns
TypeDescription
DataRedactionSettings

buildPartial()

public DataRedactionSettings buildPartial()
Returns
TypeDescription
DataRedactionSettings

clear()

public DataRedactionSettings.Builder clear()
Returns
TypeDescription
DataRedactionSettings.Builder
Overrides

clearEmailRedactionEnabled()

public DataRedactionSettings.Builder clearEmailRedactionEnabled()

If enabled, any event parameter or user property values that look like an email will be redacted.

bool email_redaction_enabled = 2;

Returns
TypeDescription
DataRedactionSettings.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DataRedactionSettings.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
DataRedactionSettings.Builder
Overrides

clearName()

public DataRedactionSettings.Builder clearName()

Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings"

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

Returns
TypeDescription
DataRedactionSettings.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DataRedactionSettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
DataRedactionSettings.Builder
Overrides

clearQueryParameterKeys()

public DataRedactionSettings.Builder clearQueryParameterKeys()

The query parameter keys to apply redaction logic to if present in the URL. Query parameter matching is case-insensitive.

Must contain at least one element if query_parameter_replacement_enabled is true. Keys cannot contain commas.

repeated string query_parameter_keys = 4;

Returns
TypeDescription
DataRedactionSettings.Builder

This builder for chaining.

clearQueryParameterRedactionEnabled()

public DataRedactionSettings.Builder clearQueryParameterRedactionEnabled()

Query Parameter redaction removes the key and value portions of a query parameter if it is in the configured set of query parameters.

If enabled, URL query replacement logic will be run for the Stream. Any query parameters defined in query_parameter_keys will be redacted.

bool query_parameter_redaction_enabled = 3;

Returns
TypeDescription
DataRedactionSettings.Builder

This builder for chaining.

clone()

public DataRedactionSettings.Builder clone()
Returns
TypeDescription
DataRedactionSettings.Builder
Overrides

getDefaultInstanceForType()

public DataRedactionSettings getDefaultInstanceForType()
Returns
TypeDescription
DataRedactionSettings

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEmailRedactionEnabled()

public boolean getEmailRedactionEnabled()

If enabled, any event parameter or user property values that look like an email will be redacted.

bool email_redaction_enabled = 2;

Returns
TypeDescription
boolean

The emailRedactionEnabled.

getName()

public String getName()

Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings"

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings"

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

Returns
TypeDescription
ByteString

The bytes for name.

getQueryParameterKeys(int index)

public String getQueryParameterKeys(int index)

The query parameter keys to apply redaction logic to if present in the URL. Query parameter matching is case-insensitive.

Must contain at least one element if query_parameter_replacement_enabled is true. Keys cannot contain commas.

repeated string query_parameter_keys = 4;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The queryParameterKeys at the given index.

getQueryParameterKeysBytes(int index)

public ByteString getQueryParameterKeysBytes(int index)

The query parameter keys to apply redaction logic to if present in the URL. Query parameter matching is case-insensitive.

Must contain at least one element if query_parameter_replacement_enabled is true. Keys cannot contain commas.

repeated string query_parameter_keys = 4;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the queryParameterKeys at the given index.

getQueryParameterKeysCount()

public int getQueryParameterKeysCount()

The query parameter keys to apply redaction logic to if present in the URL. Query parameter matching is case-insensitive.

Must contain at least one element if query_parameter_replacement_enabled is true. Keys cannot contain commas.

repeated string query_parameter_keys = 4;

Returns
TypeDescription
int

The count of queryParameterKeys.

getQueryParameterKeysList()

public ProtocolStringList getQueryParameterKeysList()

The query parameter keys to apply redaction logic to if present in the URL. Query parameter matching is case-insensitive.

Must contain at least one element if query_parameter_replacement_enabled is true. Keys cannot contain commas.

repeated string query_parameter_keys = 4;

Returns
TypeDescription
ProtocolStringList

A list containing the queryParameterKeys.

getQueryParameterRedactionEnabled()

public boolean getQueryParameterRedactionEnabled()

Query Parameter redaction removes the key and value portions of a query parameter if it is in the configured set of query parameters.

If enabled, URL query replacement logic will be run for the Stream. Any query parameters defined in query_parameter_keys will be redacted.

bool query_parameter_redaction_enabled = 3;

Returns
TypeDescription
boolean

The queryParameterRedactionEnabled.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(DataRedactionSettings other)

public DataRedactionSettings.Builder mergeFrom(DataRedactionSettings other)
Parameter
NameDescription
otherDataRedactionSettings
Returns
TypeDescription
DataRedactionSettings.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DataRedactionSettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataRedactionSettings.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public DataRedactionSettings.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
DataRedactionSettings.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DataRedactionSettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DataRedactionSettings.Builder
Overrides

setEmailRedactionEnabled(boolean value)

public DataRedactionSettings.Builder setEmailRedactionEnabled(boolean value)

If enabled, any event parameter or user property values that look like an email will be redacted.

bool email_redaction_enabled = 2;

Parameter
NameDescription
valueboolean

The emailRedactionEnabled to set.

Returns
TypeDescription
DataRedactionSettings.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DataRedactionSettings.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DataRedactionSettings.Builder
Overrides

setName(String value)

public DataRedactionSettings.Builder setName(String value)

Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings"

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

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
DataRedactionSettings.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DataRedactionSettings.Builder setNameBytes(ByteString value)

Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings"

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

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
DataRedactionSettings.Builder

This builder for chaining.

setQueryParameterKeys(int index, String value)

public DataRedactionSettings.Builder setQueryParameterKeys(int index, String value)

The query parameter keys to apply redaction logic to if present in the URL. Query parameter matching is case-insensitive.

Must contain at least one element if query_parameter_replacement_enabled is true. Keys cannot contain commas.

repeated string query_parameter_keys = 4;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The queryParameterKeys to set.

Returns
TypeDescription
DataRedactionSettings.Builder

This builder for chaining.

setQueryParameterRedactionEnabled(boolean value)

public DataRedactionSettings.Builder setQueryParameterRedactionEnabled(boolean value)

Query Parameter redaction removes the key and value portions of a query parameter if it is in the configured set of query parameters.

If enabled, URL query replacement logic will be run for the Stream. Any query parameters defined in query_parameter_keys will be redacted.

bool query_parameter_redaction_enabled = 3;

Parameter
NameDescription
valueboolean

The queryParameterRedactionEnabled to set.

Returns
TypeDescription
DataRedactionSettings.Builder

This builder for chaining.

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

public DataRedactionSettings.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
DataRedactionSettings.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final DataRedactionSettings.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DataRedactionSettings.Builder
Overrides