Show / Hide Table of Contents

Class DeliveryVehicleName

Resource name for the DeliveryVehicle resource.

Inheritance
object
DeliveryVehicleName
Implements
IResourceName
IEquatable<DeliveryVehicleName>
Inherited Members
object.GetType()
Namespace: Google.Maps.FleetEngine.Delivery.V1
Assembly: Google.Maps.FleetEngine.Delivery.V1.dll
Syntax
public sealed class DeliveryVehicleName : IResourceName, IEquatable<DeliveryVehicleName>

Constructors

DeliveryVehicleName(string, string)

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

Declaration
public DeliveryVehicleName(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 DeliveryVehicleName.ResourceNameType of the contained resource name.

Declaration
public DeliveryVehicleName.ResourceNameType Type { get; }
Property Value
Type Description
DeliveryVehicleName.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 DeliveryVehicleName with pattern providers/{provider}/deliveryVehicles/{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 DeliveryVehicleName with pattern providers/{provider}/deliveryVehicles/{vehicle}.

FormatProviderVehicle(string, string)

Formats the IDs into the string representation of this DeliveryVehicleName with pattern providers/{provider}/deliveryVehicles/{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 DeliveryVehicleName with pattern providers/{provider}/deliveryVehicles/{vehicle}.

FromProviderVehicle(string, string)

Creates a DeliveryVehicleName with the pattern providers/{provider}/deliveryVehicles/{vehicle}.

Declaration
public static DeliveryVehicleName 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
DeliveryVehicleName

A new instance of DeliveryVehicleName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a DeliveryVehicleName containing an unparsed resource name.

Declaration
public static DeliveryVehicleName FromUnparsed(UnparsedResourceName unparsedResourceName)
Parameters
Type Name Description
UnparsedResourceName unparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
DeliveryVehicleName

A new instance of DeliveryVehicleName 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 DeliveryVehicleName instance.

Declaration
public static DeliveryVehicleName Parse(string deliveryVehicleName)
Parameters
Type Name Description
string deliveryVehicleName

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

Returns
Type Description
DeliveryVehicleName

The parsed DeliveryVehicleName if successful.

Remarks

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

  • providers/{provider}/deliveryVehicles/{vehicle}

Parse(string, bool)

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

Declaration
public static DeliveryVehicleName Parse(string deliveryVehicleName, bool allowUnparsed)
Parameters
Type Name Description
string deliveryVehicleName

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
DeliveryVehicleName

The parsed DeliveryVehicleName if successful.

Remarks

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

  • providers/{provider}/deliveryVehicles/{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 DeliveryVehicleName)

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

Declaration
public static bool TryParse(string deliveryVehicleName, out DeliveryVehicleName result)
Parameters
Type Name Description
string deliveryVehicleName

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

DeliveryVehicleName result

When this method returns, the parsed DeliveryVehicleName, 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}/deliveryVehicles/{vehicle}

TryParse(string, bool, out DeliveryVehicleName)

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

Declaration
public static bool TryParse(string deliveryVehicleName, bool allowUnparsed, out DeliveryVehicleName result)
Parameters
Type Name Description
string deliveryVehicleName

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.

DeliveryVehicleName result

When this method returns, the parsed DeliveryVehicleName, 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}/deliveryVehicles/{vehicle}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(DeliveryVehicleName, DeliveryVehicleName)

Determines whether two specified resource names have the same value.

Declaration
public static bool operator ==(DeliveryVehicleName a, DeliveryVehicleName b)
Parameters
Type Name Description
DeliveryVehicleName a

The first resource name to compare, or null.

DeliveryVehicleName 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 !=(DeliveryVehicleName, DeliveryVehicleName)

Determines whether two specified resource names have different values.

Declaration
public static bool operator !=(DeliveryVehicleName a, DeliveryVehicleName b)
Parameters
Type Name Description
DeliveryVehicleName a

The first resource name to compare, or null.

DeliveryVehicleName 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.

In this article
Back to top Generated by DocFX