Show / Hide Table of Contents

Class ExpandedDataSetName

Resource name for the ExpandedDataSet resource.

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

Constructors

ExpandedDataSetName(string, string)

Constructs a new instance of a ExpandedDataSetName class from the component parts of pattern properties/{property}/expandedDataSets/{expanded_data_set}

Declaration
public ExpandedDataSetName(string propertyId, string expandedDataSetId)
Parameters
Type Name Description
string propertyId

The Property ID. Must not be null or empty.

string expandedDataSetId

The ExpandedDataSet ID. Must not be null or empty.

Properties

ExpandedDataSetId

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

Declaration
public string ExpandedDataSetId { 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 ExpandedDataSetName.ResourceNameType of the contained resource name.

Declaration
public ExpandedDataSetName.ResourceNameType Type { get; }
Property Value
Type Description
ExpandedDataSetName.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 ExpandedDataSetName with pattern properties/{property}/expandedDataSets/{expanded_data_set}.

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

The Property ID. Must not be null or empty.

string expandedDataSetId

The ExpandedDataSet ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ExpandedDataSetName with pattern properties/{property}/expandedDataSets/{expanded_data_set}.

FormatPropertyExpandedDataSet(string, string)

Formats the IDs into the string representation of this ExpandedDataSetName with pattern properties/{property}/expandedDataSets/{expanded_data_set}.

Declaration
public static string FormatPropertyExpandedDataSet(string propertyId, string expandedDataSetId)
Parameters
Type Name Description
string propertyId

The Property ID. Must not be null or empty.

string expandedDataSetId

The ExpandedDataSet ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ExpandedDataSetName with pattern properties/{property}/expandedDataSets/{expanded_data_set}.

FromPropertyExpandedDataSet(string, string)

Creates a ExpandedDataSetName with the pattern properties/{property}/expandedDataSets/{expanded_data_set}.

Declaration
public static ExpandedDataSetName FromPropertyExpandedDataSet(string propertyId, string expandedDataSetId)
Parameters
Type Name Description
string propertyId

The Property ID. Must not be null or empty.

string expandedDataSetId

The ExpandedDataSet ID. Must not be null or empty.

Returns
Type Description
ExpandedDataSetName

A new instance of ExpandedDataSetName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a ExpandedDataSetName containing an unparsed resource name.

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

The unparsed resource name. Must not be null.

Returns
Type Description
ExpandedDataSetName

A new instance of ExpandedDataSetName 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 ExpandedDataSetName instance.

Declaration
public static ExpandedDataSetName Parse(string expandedDataSetName)
Parameters
Type Name Description
string expandedDataSetName

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

Returns
Type Description
ExpandedDataSetName

The parsed ExpandedDataSetName if successful.

Remarks

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

  • properties/{property}/expandedDataSets/{expanded_data_set}

Parse(string, bool)

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

Declaration
public static ExpandedDataSetName Parse(string expandedDataSetName, bool allowUnparsed)
Parameters
Type Name Description
string expandedDataSetName

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
ExpandedDataSetName

The parsed ExpandedDataSetName if successful.

Remarks

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

  • properties/{property}/expandedDataSets/{expanded_data_set}
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 ExpandedDataSetName)

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

Declaration
public static bool TryParse(string expandedDataSetName, out ExpandedDataSetName result)
Parameters
Type Name Description
string expandedDataSetName

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

ExpandedDataSetName result

When this method returns, the parsed ExpandedDataSetName, 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}/expandedDataSets/{expanded_data_set}

TryParse(string, bool, out ExpandedDataSetName)

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

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

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.

ExpandedDataSetName result

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

Operators

operator ==(ExpandedDataSetName, ExpandedDataSetName)

Determines whether two specified resource names have the same value.

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

The first resource name to compare, or null.

ExpandedDataSetName 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 !=(ExpandedDataSetName, ExpandedDataSetName)

Determines whether two specified resource names have different values.

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

The first resource name to compare, or null.

ExpandedDataSetName 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.

In this article
Back to top Generated by DocFX