Show / Hide Table of Contents

Class DataSharingSettingsName

Resource name for the DataSharingSettings resource.

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

Constructors

DataSharingSettingsName(string)

Constructs a new instance of a DataSharingSettingsName class from the component parts of pattern accounts/{account}/dataSharingSettings

Declaration
public DataSharingSettingsName(string accountId)
Parameters
Type Name Description
string accountId

The Account ID. Must not be null or empty.

Properties

AccountId

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

Declaration
public string AccountId { 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

Type

The DataSharingSettingsName.ResourceNameType of the contained resource name.

Declaration
public DataSharingSettingsName.ResourceNameType Type { get; }
Property Value
Type Description
DataSharingSettingsName.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 DataSharingSettingsName with pattern accounts/{account}/dataSharingSettings.

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

The Account ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this DataSharingSettingsName with pattern accounts/{account}/dataSharingSettings.

FormatAccount(string)

Formats the IDs into the string representation of this DataSharingSettingsName with pattern accounts/{account}/dataSharingSettings.

Declaration
public static string FormatAccount(string accountId)
Parameters
Type Name Description
string accountId

The Account ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this DataSharingSettingsName with pattern accounts/{account}/dataSharingSettings.

FromAccount(string)

Creates a DataSharingSettingsName with the pattern accounts/{account}/dataSharingSettings .

Declaration
public static DataSharingSettingsName FromAccount(string accountId)
Parameters
Type Name Description
string accountId

The Account ID. Must not be null or empty.

Returns
Type Description
DataSharingSettingsName

A new instance of DataSharingSettingsName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a DataSharingSettingsName containing an unparsed resource name.

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

The unparsed resource name. Must not be null.

Returns
Type Description
DataSharingSettingsName

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

Declaration
public static DataSharingSettingsName Parse(string dataSharingSettingsName)
Parameters
Type Name Description
string dataSharingSettingsName

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

Returns
Type Description
DataSharingSettingsName

The parsed DataSharingSettingsName if successful.

Remarks

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

  • accounts/{account}/dataSharingSettings

Parse(string, bool)

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

Declaration
public static DataSharingSettingsName Parse(string dataSharingSettingsName, bool allowUnparsed)
Parameters
Type Name Description
string dataSharingSettingsName

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
DataSharingSettingsName

The parsed DataSharingSettingsName if successful.

Remarks

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

  • accounts/{account}/dataSharingSettings
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 DataSharingSettingsName)

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

Declaration
public static bool TryParse(string dataSharingSettingsName, out DataSharingSettingsName result)
Parameters
Type Name Description
string dataSharingSettingsName

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

DataSharingSettingsName result

When this method returns, the parsed DataSharingSettingsName, 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:

  • accounts/{account}/dataSharingSettings

TryParse(string, bool, out DataSharingSettingsName)

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

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

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.

DataSharingSettingsName result

When this method returns, the parsed DataSharingSettingsName, 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:

  • accounts/{account}/dataSharingSettings
Or may be in any format if allowUnparsed is true.

Operators

operator ==(DataSharingSettingsName, DataSharingSettingsName)

Determines whether two specified resource names have the same value.

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

The first resource name to compare, or null.

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

Determines whether two specified resource names have different values.

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

The first resource name to compare, or null.

DataSharingSettingsName 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