Class DataRetentionSettingsName

Resource name for the DataRetentionSettings resource.

Inheritance
object
DataRetentionSettingsName
Implements
Inherited Members
Namespace: Google.Analytics.Admin.V1Alpha
Assembly: Google.Analytics.Admin.V1Alpha.dll
Syntax
public sealed class DataRetentionSettingsName : IResourceName, IEquatable<DataRetentionSettingsName>

Constructors

DataRetentionSettingsName(string)

Constructs a new instance of a DataRetentionSettingsName class from the component parts of pattern properties/{property}/dataRetentionSettings

Declaration
public DataRetentionSettingsName(string propertyId)
Parameters
Type Name Description
string propertyId

The Property ID. Must not be null or empty.

Properties

IsKnownPattern

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

Declaration
public bool IsKnownPattern { get; }
Property Value
Type Description
bool
Implements

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 DataRetentionSettingsName.ResourceNameType of the contained resource name.

Declaration
public DataRetentionSettingsName.ResourceNameType Type { get; }
Property Value
Type Description
DataRetentionSettingsName.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)

Formats the IDs into the string representation of this DataRetentionSettingsName with pattern properties/{property}/dataRetentionSettings.

Declaration
public static string Format(string propertyId)
Parameters
Type Name Description
string propertyId

The Property ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DataRetentionSettingsName with pattern properties/{property}/dataRetentionSettings.

FormatProperty(string)

Formats the IDs into the string representation of this DataRetentionSettingsName with pattern properties/{property}/dataRetentionSettings.

Declaration
public static string FormatProperty(string propertyId)
Parameters
Type Name Description
string propertyId

The Property ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DataRetentionSettingsName with pattern properties/{property}/dataRetentionSettings.

FromProperty(string)

Creates a DataRetentionSettingsName with the pattern properties/{property}/dataRetentionSettings.

Declaration
public static DataRetentionSettingsName FromProperty(string propertyId)
Parameters
Type Name Description
string propertyId

The Property ID. Must not be null or empty.
Returns
Type Description
DataRetentionSettingsName

A new instance of DataRetentionSettingsName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a DataRetentionSettingsName containing an unparsed resource name.

Declaration
public static DataRetentionSettingsName FromUnparsed(UnparsedResourceName unparsedResourceName)
Parameters
Type Name Description
UnparsedResourceName unparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
DataRetentionSettingsName

A new instance of DataRetentionSettingsName containing the provided unparsedResourceName.

GetHashCode()

Returns a hash code for this resource name.

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides

Parse(string)

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

Declaration
public static DataRetentionSettingsName Parse(string dataRetentionSettingsName)
Parameters
Type Name Description
string dataRetentionSettingsName

The resource name in string form. Must not be null.
Returns
Type Description
DataRetentionSettingsName

The parsed DataRetentionSettingsName if successful.
Remarks

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

  • properties/{property}/dataRetentionSettings

Parse(string, bool)

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

Declaration
public static DataRetentionSettingsName Parse(string dataRetentionSettingsName, bool allowUnparsed)
Parameters
Type Name Description
string dataRetentionSettingsName

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
DataRetentionSettingsName

The parsed DataRetentionSettingsName if successful.
Remarks

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

  • properties/{property}/dataRetentionSettings
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
Implements

TryParse(string, out DataRetentionSettingsName)

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

Declaration
public static bool TryParse(string dataRetentionSettingsName, out DataRetentionSettingsName result)
Parameters
Type Name Description
string dataRetentionSettingsName

The resource name in string form. Must not be null.
DataRetentionSettingsName result

When this method returns, the parsed DataRetentionSettingsName, 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}/dataRetentionSettings

TryParse(string, bool, out DataRetentionSettingsName)

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

Declaration
public static bool TryParse(string dataRetentionSettingsName, bool allowUnparsed, out DataRetentionSettingsName result)
Parameters
Type Name Description
string dataRetentionSettingsName

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.
DataRetentionSettingsName result

When this method returns, the parsed DataRetentionSettingsName, 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}/dataRetentionSettings
Or may be in any format if allowUnparsed is true.

Operators

operator ==(DataRetentionSettingsName, DataRetentionSettingsName)

Determines whether two specified resource names have the same value.

Declaration
public static bool operator ==(DataRetentionSettingsName a, DataRetentionSettingsName b)
Parameters
Type Name Description
DataRetentionSettingsName a

The first resource name to compare, or null.
DataRetentionSettingsName 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 !=(DataRetentionSettingsName, DataRetentionSettingsName)

Determines whether two specified resource names have different values.

Declaration
public static bool operator !=(DataRetentionSettingsName a, DataRetentionSettingsName b)
Parameters
Type Name Description
DataRetentionSettingsName a

The first resource name to compare, or null.
DataRetentionSettingsName 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.