Class TaskName

Resource name for the Task resource.

Inheritance

object

TaskName

Implements

IResourceName

IEquatable<TaskName>

Inherited Members

object.GetType()

Namespace: Google.Maps.FleetEngine.Delivery.V1

Assembly: Google.Maps.FleetEngine.Delivery.V1.dll

Syntax

public sealed class TaskName : IResourceName, IEquatable<TaskName>

Constructors

TaskName(string, string)

Constructs a new instance of a TaskName class from the component parts of pattern providers/{provider}/tasks/{task}

Declaration

public TaskName(string providerId, string taskId)

Parameters

Type	Name	Description
string	providerId	The Provider ID. Must not be null or empty.
string	taskId	The Task 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

ProviderId

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

Declaration

public string ProviderId { get; }

Property Value

Type	Description
string

TaskId

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

Declaration

public string TaskId { get; }

Property Value

Type	Description
string

Type

The TaskName.ResourceNameType of the contained resource name.

Declaration

public TaskName.ResourceNameType Type { get; }

Property Value

Type	Description
TaskName.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, string)

Formats the IDs into the string representation of this TaskName with pattern providers/{provider}/tasks/{task}.

Declaration

public static string Format(string providerId, string taskId)

Parameters

Type	Name	Description
string	providerId	The Provider ID. Must not be null or empty.
string	taskId	The Task ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this TaskName with pattern providers/{provider}/tasks/{task} .

FormatProviderTask(string, string)

Formats the IDs into the string representation of this TaskName with pattern providers/{provider}/tasks/{task}.

Declaration

public static string FormatProviderTask(string providerId, string taskId)

Parameters

Type	Name	Description
string	providerId	The Provider ID. Must not be null or empty.
string	taskId	The Task ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this TaskName with pattern providers/{provider}/tasks/{task} .

FromProviderTask(string, string)

Creates a TaskName with the pattern providers/{provider}/tasks/{task}.

Declaration

public static TaskName FromProviderTask(string providerId, string taskId)

Parameters

Type	Name	Description
string	providerId	The Provider ID. Must not be null or empty.
string	taskId	The Task ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a TaskName containing an unparsed resource name.

Declaration

public static TaskName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

Type	Description
TaskName	A new instance of TaskName 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 TaskName instance.

Declaration

public static TaskName Parse(string taskName)

Parameters

Type	Name	Description
string	taskName	The resource name in string form. Must not be null.

Returns

Type	Description
TaskName	The parsed TaskName if successful.

Remarks

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

• providers/{provider}/tasks/{task}

Parse(string, bool)

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

Declaration

public static TaskName Parse(string taskName, bool allowUnparsed)

Parameters

Type	Name	Description
string	taskName	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
TaskName	The parsed TaskName if successful.

Remarks

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

• providers/{provider}/tasks/{task}

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

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

Declaration

public static bool TryParse(string taskName, out TaskName result)

Parameters

Type	Name	Description
string	taskName	The resource name in string form. Must not be null.
TaskName	result	When this method returns, the parsed TaskName, 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:

• providers/{provider}/tasks/{task}

TryParse(string, bool, out TaskName)

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

Declaration

public static bool TryParse(string taskName, bool allowUnparsed, out TaskName result)

Parameters

Type	Name	Description
string	taskName	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.
TaskName	result	When this method returns, the parsed TaskName, 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:

• providers/{provider}/tasks/{task}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(TaskName, TaskName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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