Class DataRedactionSettings (0.56.0)

public final class DataRedactionSettings extends GeneratedMessageV3 implements DataRedactionSettingsOrBuilder

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

Protobuf type google.analytics.admin.v1alpha.DataRedactionSettings

Static Fields

EMAIL_REDACTION_ENABLED_FIELD_NUMBER

public static final int EMAIL_REDACTION_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

QUERY_PARAMETER_KEYS_FIELD_NUMBER

public static final int QUERY_PARAMETER_KEYS_FIELD_NUMBER
Field Value
Type Description
int

QUERY_PARAMETER_REDACTION_ENABLED_FIELD_NUMBER

public static final int QUERY_PARAMETER_REDACTION_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DataRedactionSettings getDefaultInstance()
Returns
Type Description
DataRedactionSettings

getDescriptor()

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

newBuilder()

public static DataRedactionSettings.Builder newBuilder()
Returns
Type Description
DataRedactionSettings.Builder

newBuilder(DataRedactionSettings prototype)

public static DataRedactionSettings.Builder newBuilder(DataRedactionSettings prototype)
Parameter
Name Description
prototype DataRedactionSettings
Returns
Type Description
DataRedactionSettings.Builder

parseDelimitedFrom(InputStream input)

public static DataRedactionSettings parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataRedactionSettings
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataRedactionSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataRedactionSettings
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DataRedactionSettings parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DataRedactionSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DataRedactionSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataRedactionSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DataRedactionSettings parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DataRedactionSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DataRedactionSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataRedactionSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DataRedactionSettings parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DataRedactionSettings
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DataRedactionSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataRedactionSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DataRedactionSettings parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataRedactionSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataRedactionSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataRedactionSettings
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DataRedactionSettings parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DataRedactionSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DataRedactionSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataRedactionSettings
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DataRedactionSettings> parser()
Returns
Type Description
Parser<DataRedactionSettings>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public DataRedactionSettings getDefaultInstanceForType()
Returns
Type Description
DataRedactionSettings

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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<DataRedactionSettings> getParserForType()
Returns
Type Description
Parser<DataRedactionSettings>
Overrides

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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

The queryParameterRedactionEnabled.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DataRedactionSettings.Builder newBuilderForType()
Returns
Type Description
DataRedactionSettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DataRedactionSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DataRedactionSettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DataRedactionSettings.Builder toBuilder()
Returns
Type Description
DataRedactionSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException