Class ProviderName

Resource name for the Provider resource.

Inheritance

object

ProviderName

Implements

IResourceName

IEquatable<ProviderName>

Inherited Members

object.GetType()

Namespace: Google.Maps.FleetEngine.Delivery.V1

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

Syntax

public sealed class ProviderName : IResourceName, IEquatable<ProviderName>

Constructors

ProviderName(string)

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

Declaration

public ProviderName(string providerId)

Parameters

Type	Name	Description
string	providerId	The Provider 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

Type

The ProviderName.ResourceNameType of the contained resource name.

Declaration

public ProviderName.ResourceNameType Type { get; }

Property Value

Type	Description
ProviderName.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 ProviderName with pattern providers/{provider}.

Declaration

public static string Format(string providerId)

Parameters

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

Returns

Type	Description
string	The string representation of this ProviderName with pattern providers/{provider}.

FormatProvider(string)

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

Declaration

public static string FormatProvider(string providerId)

Parameters

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

Returns

Type	Description
string	The string representation of this ProviderName with pattern providers/{provider}.

FromProvider(string)

Creates a ProviderName with the pattern providers/{provider}.

Declaration

public static ProviderName FromProvider(string providerId)

Parameters

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

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a ProviderName containing an unparsed resource name.

Declaration

public static ProviderName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static ProviderName Parse(string providerName)

Parameters

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

Returns

Type	Description
ProviderName	The parsed ProviderName if successful.

Remarks

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

• providers/{provider}

Parse(string, bool)

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

Declaration

public static ProviderName Parse(string providerName, bool allowUnparsed)

Parameters

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

Remarks

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

• providers/{provider}

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

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

Declaration

public static bool TryParse(string providerName, out ProviderName result)

Parameters

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

TryParse(string, bool, out ProviderName)

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

Declaration

public static bool TryParse(string providerName, bool allowUnparsed, out ProviderName result)

Parameters

Type	Name	Description
string	providerName	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.
ProviderName	result	When this method returns, the parsed ProviderName, 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}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ProviderName, ProviderName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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