Class QueueName (3.0.0-beta01)

public sealed class QueueName : IResourceName, IEquatable<QueueName>

Resource name for the Queue resource.

Inheritance

Object > QueueName

Namespace

Google.Cloud.Tasks.V2Beta3

Assembly

Google.Cloud.Tasks.V2Beta3.dll

Constructors

QueueName(String, String, String)

public QueueName(string projectId, string locationId, string queueId)

Constructs a new instance of a QueueName class from the component parts of pattern projects/{project}/locations/{location}/queues/{queue}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

queueIdString

The Queue 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
TypeDescription
Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

QueueId

public string QueueId { get; }

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

Property Value
TypeDescription
String

Type

public QueueName.ResourceNameType Type { get; }

The QueueName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
QueueName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(String, String, String)

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

Formats the IDs into the string representation of this QueueName with pattern projects/{project}/locations/{location}/queues/{queue}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

queueIdString

The Queue ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this QueueName with pattern projects/{project}/locations/{location}/queues/{queue}.

FormatProjectLocationQueue(String, String, String)

public static string FormatProjectLocationQueue(string projectId, string locationId, string queueId)

Formats the IDs into the string representation of this QueueName with pattern projects/{project}/locations/{location}/queues/{queue}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

queueIdString

The Queue ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this QueueName with pattern projects/{project}/locations/{location}/queues/{queue}.

FromProjectLocationQueue(String, String, String)

public static QueueName FromProjectLocationQueue(string projectId, string locationId, string queueId)

Creates a QueueName with the pattern projects/{project}/locations/{location}/queues/{queue} .

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

queueIdString

The Queue ID. Must not be null or empty.

Returns
TypeDescription
QueueName

A new instance of QueueName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static QueueName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a QueueName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
QueueName

A new instance of QueueName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static QueueName Parse(string queueName)

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

Parameter
NameDescription
queueNameString

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

Returns
TypeDescription
QueueName

The parsed QueueName if successful.

Remarks

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

  • projects/{project}/locations/{location}/queues/{queue}

Parse(String, Boolean)

public static QueueName Parse(string queueName, bool allowUnparsed)

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

Parameters
NameDescription
queueNameString

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

allowUnparsedBoolean

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
TypeDescription
QueueName

The parsed QueueName if successful.

Remarks

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

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

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
String

The string representation of the resource name.

Overrides

TryParse(String, out QueueName)

public static bool TryParse(string queueName, out QueueName result)

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

Parameters
NameDescription
queueNameString

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

resultQueueName

When this method returns, the parsed QueueName, or null if parsing failed.

Returns
TypeDescription
Boolean

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}/queues/{queue}

TryParse(String, Boolean, out QueueName)

public static bool TryParse(string queueName, bool allowUnparsed, out QueueName result)

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

Parameters
NameDescription
queueNameString

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

allowUnparsedBoolean

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.

resultQueueName

When this method returns, the parsed QueueName, or null if parsing failed.

Returns
TypeDescription
Boolean

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}/queues/{queue}
Or may be in any format if allowUnparsed is true.

Operators

Equality(QueueName, QueueName)

public static bool operator ==(QueueName a, QueueName b)
Parameters
NameDescription
aQueueName
bQueueName
Returns
TypeDescription
Boolean

Inequality(QueueName, QueueName)

public static bool operator !=(QueueName a, QueueName b)
Parameters
NameDescription
aQueueName
bQueueName
Returns
TypeDescription
Boolean