Class VehicleName

Resource name for the Vehicle resource.

Inheritance

object

VehicleName

Implements

IResourceName

IEquatable<VehicleName>

Inherited Members

object.GetType()

Namespace: Google.Maps.FleetEngine.V1

Assembly: Google.Maps.FleetEngine.V1.dll

Syntax

public sealed class VehicleName : IResourceName, IEquatable<VehicleName>

Constructors

VehicleName(string, string)

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

Declaration

public VehicleName(string providerId, string vehicleId)

Parameters

Type	Name	Description
string	providerId	The Provider ID. Must not be null or empty.
string	vehicleId	The Vehicle 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 VehicleName.ResourceNameType of the contained resource name.

Declaration

public VehicleName.ResourceNameType Type { get; }

Property Value

Type	Description
VehicleName.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

VehicleId

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

Declaration

public string VehicleId { get; }

Property Value

Type	Description
string

Methods

Format(string, string)

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

Declaration

public static string Format(string providerId, string vehicleId)

Parameters

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

Returns

Type	Description
string	The string representation of this VehicleName with pattern providers/{provider}/vehicles/{vehicle}.

FormatProviderVehicle(string, string)

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

Declaration

public static string FormatProviderVehicle(string providerId, string vehicleId)

Parameters

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

Returns

Type	Description
string	The string representation of this VehicleName with pattern providers/{provider}/vehicles/{vehicle}.

FromProviderVehicle(string, string)

Creates a VehicleName with the pattern providers/{provider}/vehicles/{vehicle}.

Declaration

public static VehicleName FromProviderVehicle(string providerId, string vehicleId)

Parameters

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

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a VehicleName containing an unparsed resource name.

Declaration

public static VehicleName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static VehicleName Parse(string vehicleName)

Parameters

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

Returns

Type	Description
VehicleName	The parsed VehicleName if successful.

Remarks

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

• providers/{provider}/vehicles/{vehicle}

Parse(string, bool)

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

Declaration

public static VehicleName Parse(string vehicleName, bool allowUnparsed)

Parameters

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

Remarks

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

• providers/{provider}/vehicles/{vehicle}

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

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

Declaration

public static bool TryParse(string vehicleName, out VehicleName result)

Parameters

Type	Name	Description
string	vehicleName	The resource name in string form. Must not be null.
VehicleName	result	When this method returns, the parsed VehicleName, 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}/vehicles/{vehicle}

TryParse(string, bool, out VehicleName)

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

Declaration

public static bool TryParse(string vehicleName, bool allowUnparsed, out VehicleName result)

Parameters

Type	Name	Description
string	vehicleName	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.
VehicleName	result	When this method returns, the parsed VehicleName, 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}/vehicles/{vehicle}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(VehicleName, VehicleName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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