Class DataRedactionSettingsName

Resource name for the DataRedactionSettings resource.

Inheritance

object

DataRedactionSettingsName

Implements

IResourceName

IEquatable<DataRedactionSettingsName>

Inherited Members

object.GetType()

Namespace: Google.Analytics.Admin.V1Alpha

Assembly: Google.Analytics.Admin.V1Alpha.dll

Syntax

public sealed class DataRedactionSettingsName : IResourceName, IEquatable<DataRedactionSettingsName>

Constructors

DataRedactionSettingsName(string, string)

Constructs a new instance of a DataRedactionSettingsName class from the component parts of pattern properties/{property}/dataStreams/{data_stream}/dataRedactionSettings

Declaration

public DataRedactionSettingsName(string propertyId, string dataStreamId)

Parameters

Type	Name	Description
string	propertyId	The Property ID. Must not be null or empty.
string	dataStreamId	The DataStream ID. Must not be null or empty.

Properties

DataStreamId

The DataStream ID. Will not be null, unless this instance contains an unparsed resource name.

Declaration

public string DataStreamId { get; }

Property Value

Type	Description
string

IsKnownPattern

Whether this instance contains a resource name with a known pattern.

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
bool

Implements

IResourceName.IsKnownPattern

PropertyId

The Property ID. Will not be null, unless this instance contains an unparsed resource name.

Declaration

public string PropertyId { get; }

Property Value

Type	Description
string

Type

The DataRedactionSettingsName.ResourceNameType of the contained resource name.

Declaration

public DataRedactionSettingsName.ResourceNameType Type { get; }

Property Value

Type	Description
DataRedactionSettingsName.ResourceNameType

UnparsedResource

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
UnparsedResourceName

Methods

Format(string, string)

Formats the IDs into the string representation of this DataRedactionSettingsName with pattern properties/{property}/dataStreams/{data_stream}/dataRedactionSettings.

Declaration

public static string Format(string propertyId, string dataStreamId)

Parameters

Type	Name	Description
string	propertyId	The Property ID. Must not be null or empty.
string	dataStreamId	The DataStream ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this DataRedactionSettingsName with pattern properties/{property}/dataStreams/{data_stream}/dataRedactionSettings.

FormatPropertyDataStream(string, string)

Formats the IDs into the string representation of this DataRedactionSettingsName with pattern properties/{property}/dataStreams/{data_stream}/dataRedactionSettings.

Declaration

public static string FormatPropertyDataStream(string propertyId, string dataStreamId)

Parameters

Type	Name	Description
string	propertyId	The Property ID. Must not be null or empty.
string	dataStreamId	The DataStream ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this DataRedactionSettingsName with pattern properties/{property}/dataStreams/{data_stream}/dataRedactionSettings.

FromPropertyDataStream(string, string)

Creates a DataRedactionSettingsName with the pattern properties/{property}/dataStreams/{data_stream}/dataRedactionSettings.

Declaration

public static DataRedactionSettingsName FromPropertyDataStream(string propertyId, string dataStreamId)

Parameters

Type	Name	Description
string	propertyId	The Property ID. Must not be null or empty.
string	dataStreamId	The DataStream ID. Must not be null or empty.

Returns

Type	Description
DataRedactionSettingsName	A new instance of DataRedactionSettingsName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a DataRedactionSettingsName containing an unparsed resource name.

Declaration

public static DataRedactionSettingsName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

Type	Name	Description
UnparsedResourceName	unparsedResourceName	The unparsed resource name. Must not be null.

Returns

Type	Description
DataRedactionSettingsName	A new instance of DataRedactionSettingsName containing the provided unparsedResourceName.

GetHashCode()

Returns a hash code for this resource name.

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

Parses the given resource name string into a new DataRedactionSettingsName instance.

Declaration

public static DataRedactionSettingsName Parse(string dataRedactionSettingsName)

Parameters

Type	Name	Description
string	dataRedactionSettingsName	The resource name in string form. Must not be null.

Returns

Type	Description
DataRedactionSettingsName	The parsed DataRedactionSettingsName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• properties/{property}/dataStreams/{data_stream}/dataRedactionSettings

Parse(string, bool)

Parses the given resource name string into a new DataRedactionSettingsName instance; optionally allowing an unparseable resource name.

Declaration

public static DataRedactionSettingsName Parse(string dataRedactionSettingsName, bool allowUnparsed)

Parameters

Type	Name	Description
string	dataRedactionSettingsName	The resource name in string form. Must not be null.
bool	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

Returns

Type	Description
DataRedactionSettingsName	The parsed DataRedactionSettingsName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• properties/{property}/dataStreams/{data_stream}/dataRedactionSettings

Or may be in any format if allowUnparsed is true.

ToString()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
string	The string representation of the resource name.

Overrides

object.ToString()

Implements

IResourceName.ToString()

TryParse(string, out DataRedactionSettingsName)

Tries to parse the given resource name string into a new DataRedactionSettingsName instance.

Declaration

public static bool TryParse(string dataRedactionSettingsName, out DataRedactionSettingsName result)

Parameters

Type	Name	Description
string	dataRedactionSettingsName	The resource name in string form. Must not be null.
DataRedactionSettingsName	result	When this method returns, the parsed DataRedactionSettingsName, or null if parsing failed.

Returns

Type	Description
bool	true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• properties/{property}/dataStreams/{data_stream}/dataRedactionSettings

TryParse(string, bool, out DataRedactionSettingsName)

Tries to parse the given resource name string into a new DataRedactionSettingsName instance; optionally allowing an unparseable resource name.

Declaration

public static bool TryParse(string dataRedactionSettingsName, bool allowUnparsed, out DataRedactionSettingsName result)

Parameters

Type	Name	Description
string	dataRedactionSettingsName	The resource name in string form. Must not be null.
bool	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
DataRedactionSettingsName	result	When this method returns, the parsed DataRedactionSettingsName, or null if parsing failed.

Returns

Type	Description
bool	true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• properties/{property}/dataStreams/{data_stream}/dataRedactionSettings

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DataRedactionSettingsName, DataRedactionSettingsName)

Determines whether two specified resource names have the same value.

Declaration

public static bool operator ==(DataRedactionSettingsName a, DataRedactionSettingsName b)

Parameters

Type	Name	Description
DataRedactionSettingsName	a	The first resource name to compare, or null.
DataRedactionSettingsName	b	The second resource name to compare, or null.

Returns

Type	Description
bool	true if the value of a is the same as the value of b; otherwise, false.

operator !=(DataRedactionSettingsName, DataRedactionSettingsName)

Determines whether two specified resource names have different values.

Declaration

public static bool operator !=(DataRedactionSettingsName a, DataRedactionSettingsName b)

Parameters

Type	Name	Description
DataRedactionSettingsName	a	The first resource name to compare, or null.
DataRedactionSettingsName	b	The second resource name to compare, or null.

Returns

Type	Description
bool	true if the value of a is different from the value of b; otherwise, false.