Migration Center v1 API - Class PreferenceSetName (1.4.0) 

public sealed class PreferenceSetName : IResourceName, IEquatable<PreferenceSetName>

Reference documentation and code samples for the Migration Center v1 API class PreferenceSetName.

Resource name for the PreferenceSet resource.

Inheritance

object > PreferenceSetName

Namespace

Google.Cloud.MigrationCenter.V1

Assembly

Google.Cloud.MigrationCenter.V1.dll

Constructors

PreferenceSetName(string, string, string)

public PreferenceSetName(string projectId, string locationId, string preferenceSetId)

Constructs a new instance of a PreferenceSetName class from the component parts of pattern projects/{project}/locations/{location}/preferenceSets/{preference_set}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
preferenceSetId string

The PreferenceSet ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type Description
bool

LocationId

public string LocationId { get; }

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

Property Value
Type Description
string

PreferenceSetId

public string PreferenceSetId { get; }

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

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

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

Property Value
Type Description
string

Type

public PreferenceSetName.ResourceNameType Type { get; }

The PreferenceSetName.ResourceNameType of the contained resource name.

Property Value
Type Description
PreferenceSetNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

Methods

Format(string, string, string)

public static string Format(string projectId, string locationId, string preferenceSetId)

Formats the IDs into the string representation of this PreferenceSetName with pattern projects/{project}/locations/{location}/preferenceSets/{preference_set}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
preferenceSetId string

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

The string representation of this PreferenceSetName with pattern projects/{project}/locations/{location}/preferenceSets/{preference_set}.

FormatProjectLocationPreferenceSet(string, string, string)

public static string FormatProjectLocationPreferenceSet(string projectId, string locationId, string preferenceSetId)

Formats the IDs into the string representation of this PreferenceSetName with pattern projects/{project}/locations/{location}/preferenceSets/{preference_set}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
preferenceSetId string

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

The string representation of this PreferenceSetName with pattern projects/{project}/locations/{location}/preferenceSets/{preference_set}.

FromProjectLocationPreferenceSet(string, string, string)

public static PreferenceSetName FromProjectLocationPreferenceSet(string projectId, string locationId, string preferenceSetId)

Creates a PreferenceSetName with the pattern projects/{project}/locations/{location}/preferenceSets/{preference_set}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
preferenceSetId string

The PreferenceSet ID. Must not be null or empty.
Returns
Type Description
PreferenceSetName

A new instance of PreferenceSetName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PreferenceSetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PreferenceSetName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of PreferenceSetName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static PreferenceSetName Parse(string preferenceSetName)

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

Parameter
Name Description
preferenceSetName string

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

The parsed PreferenceSetName if successful.
Remarks

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

  • projects/{project}/locations/{location}/preferenceSets/{preference_set}

Parse(string, bool)

public static PreferenceSetName Parse(string preferenceSetName, bool allowUnparsed)

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

Parameters
Name Description
preferenceSetName string

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

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
PreferenceSetName

The parsed PreferenceSetName if successful.
Remarks

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

  • projects/{project}/locations/{location}/preferenceSets/{preference_set}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type Description
string

The string representation of the resource name.
Overrides

TryParse(string, out PreferenceSetName)

public static bool TryParse(string preferenceSetName, out PreferenceSetName result)

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

Parameters
Name Description
preferenceSetName string

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

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

  • projects/{project}/locations/{location}/preferenceSets/{preference_set}

TryParse(string, bool, out PreferenceSetName)

public static bool TryParse(string preferenceSetName, bool allowUnparsed, out PreferenceSetName result)

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

Parameters
Name Description
preferenceSetName string

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

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

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

  • projects/{project}/locations/{location}/preferenceSets/{preference_set}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(PreferenceSetName, PreferenceSetName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a PreferenceSetName

The first resource name to compare, or null.
b PreferenceSetName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a PreferenceSetName

The first resource name to compare, or null.
b PreferenceSetName

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.