Rapid Migration Assessment v1 API - Class CollectorName (1.3.0)

Version latest

• 1.3.0 (latest)
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class CollectorName : IResourceName, IEquatable<CollectorName>

Reference documentation and code samples for the Rapid Migration Assessment v1 API class CollectorName.

Resource name for the Collector resource.

Inheritance

object > CollectorName

Implements

IResourceName, IEquatableCollectorName

Inherited Members

object.GetType()

Namespace

Google.Cloud.RapidMigrationAssessment.V1

Assembly

Google.Cloud.RapidMigrationAssessment.V1.dll

Constructors

CollectorName(string, string, string)

public CollectorName(string projectId, string locationId, string collectorId)

Constructs a new instance of a CollectorName class from the component parts of pattern projects/{project}/locations/{location}/collectors/{collector}

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.
collectorId	string The Collector ID. Must not be null or empty.

Properties

CollectorId

public string CollectorId { get; }

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

Property Value
Type	Description
string

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

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 CollectorName.ResourceNameType Type { get; }

The CollectorName.ResourceNameType of the contained resource name.

Property Value
Type	Description
CollectorNameResourceNameType

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

Formats the IDs into the string representation of this CollectorName with pattern projects/{project}/locations/{location}/collectors/{collector}.

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.
collectorId	string The Collector ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this CollectorName with pattern projects/{project}/locations/{location}/collectors/{collector}.

FormatProjectLocationCollector(string, string, string)

public static string FormatProjectLocationCollector(string projectId, string locationId, string collectorId)

Formats the IDs into the string representation of this CollectorName with pattern projects/{project}/locations/{location}/collectors/{collector}.

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.
collectorId	string The Collector ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this CollectorName with pattern projects/{project}/locations/{location}/collectors/{collector}.

FromProjectLocationCollector(string, string, string)

public static CollectorName FromProjectLocationCollector(string projectId, string locationId, string collectorId)

Creates a CollectorName with the pattern projects/{project}/locations/{location}/collectors/{collector}.

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.
collectorId	string The Collector ID. Must not be null or empty.

Returns
Type	Description
CollectorName	A new instance of CollectorName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CollectorName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CollectorName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
CollectorName	A new instance of CollectorName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static CollectorName Parse(string collectorName)

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

Parameter
Name	Description
collectorName	string The resource name in string form. Must not be null.

Returns
Type	Description
CollectorName	The parsed CollectorName if successful.

Remarks

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

• projects/{project}/locations/{location}/collectors/{collector}

Parse(string, bool)

public static CollectorName Parse(string collectorName, bool allowUnparsed)

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

Parameters
Name	Description
collectorName	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
CollectorName	The parsed CollectorName if successful.

Remarks

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

• projects/{project}/locations/{location}/collectors/{collector}

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

object.ToString()

TryParse(string, out CollectorName)

public static bool TryParse(string collectorName, out CollectorName result)

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

Parameters
Name	Description
collectorName	string The resource name in string form. Must not be null.
result	CollectorName When this method returns, the parsed CollectorName, 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}/collectors/{collector}

TryParse(string, bool, out CollectorName)

public static bool TryParse(string collectorName, bool allowUnparsed, out CollectorName result)

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

Parameters
Name	Description
collectorName	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	CollectorName When this method returns, the parsed CollectorName, 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}/collectors/{collector}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(CollectorName, CollectorName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	CollectorName The first resource name to compare, or null.
b	CollectorName 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 !=(CollectorName, CollectorName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	CollectorName The first resource name to compare, or null.
b	CollectorName 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.