Show / Hide Table of Contents

Class UserProvidedDataSettingsName

Resource name for the UserProvidedDataSettings resource.

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

Constructors

UserProvidedDataSettingsName(string)

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

Declaration
public UserProvidedDataSettingsName(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
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 UserProvidedDataSettingsName.ResourceNameType of the contained resource name.

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

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 UserProvidedDataSettingsName with pattern properties/{property}/userProvidedDataSettings.

FormatProperty(string)

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

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 UserProvidedDataSettingsName with pattern properties/{property}/userProvidedDataSettings.

FromProperty(string)

Creates a UserProvidedDataSettingsName with the pattern properties/{property}/userProvidedDataSettings.

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

The Property ID. Must not be null or empty.

Returns
Type Description
UserProvidedDataSettingsName

A new instance of UserProvidedDataSettingsName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a UserProvidedDataSettingsName containing an unparsed resource name.

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

The unparsed resource name. Must not be null.

Returns
Type Description
UserProvidedDataSettingsName

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

Declaration
public static UserProvidedDataSettingsName Parse(string userProvidedDataSettingsName)
Parameters
Type Name Description
string userProvidedDataSettingsName

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

Returns
Type Description
UserProvidedDataSettingsName

The parsed UserProvidedDataSettingsName if successful.

Remarks

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

  • properties/{property}/userProvidedDataSettings

Parse(string, bool)

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

Declaration
public static UserProvidedDataSettingsName Parse(string userProvidedDataSettingsName, bool allowUnparsed)
Parameters
Type Name Description
string userProvidedDataSettingsName

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
UserProvidedDataSettingsName

The parsed UserProvidedDataSettingsName if successful.

Remarks

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

  • properties/{property}/userProvidedDataSettings

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 UserProvidedDataSettingsName)

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

Declaration
public static bool TryParse(string userProvidedDataSettingsName, out UserProvidedDataSettingsName result)
Parameters
Type Name Description
string userProvidedDataSettingsName

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

UserProvidedDataSettingsName result

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

TryParse(string, bool, out UserProvidedDataSettingsName)

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

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

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.

UserProvidedDataSettingsName result

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

Or may be in any format if allowUnparsed is true.

Operators

operator ==(UserProvidedDataSettingsName, UserProvidedDataSettingsName)

Determines whether two specified resource names have the same value.

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

The first resource name to compare, or null.

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

Determines whether two specified resource names have different values.

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

The first resource name to compare, or null.

UserProvidedDataSettingsName 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