Class TripName

Resource name for the Trip resource.

Inheritance

object

TripName

Implements

IResourceName

IEquatable<TripName>

Inherited Members

object.GetType()

Namespace: Google.Maps.FleetEngine.V1

Assembly: Google.Maps.FleetEngine.V1.dll

Syntax

public sealed class TripName : IResourceName, IEquatable<TripName>

Constructors

TripName(string, string)

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

Declaration

public TripName(string providerId, string tripId)

Parameters

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

TripId

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

Declaration

public string TripId { get; }

Property Value

Type	Description
string

Type

The TripName.ResourceNameType of the contained resource name.

Declaration

public TripName.ResourceNameType Type { get; }

Property Value

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

Declaration

public static string Format(string providerId, string tripId)

Parameters

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

Returns

Type	Description
string	The string representation of this TripName with pattern providers/{provider}/trips/{trip} .

FormatProviderTrip(string, string)

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

Declaration

public static string FormatProviderTrip(string providerId, string tripId)

Parameters

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

Returns

Type	Description
string	The string representation of this TripName with pattern providers/{provider}/trips/{trip} .

FromProviderTrip(string, string)

Creates a TripName with the pattern providers/{provider}/trips/{trip}.

Declaration

public static TripName FromProviderTrip(string providerId, string tripId)

Parameters

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

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a TripName containing an unparsed resource name.

Declaration

public static TripName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static TripName Parse(string tripName)

Parameters

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

Returns

Type	Description
TripName	The parsed TripName if successful.

Remarks

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

• providers/{provider}/trips/{trip}

Parse(string, bool)

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

Declaration

public static TripName Parse(string tripName, bool allowUnparsed)

Parameters

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

Remarks

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

• providers/{provider}/trips/{trip}

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

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

Declaration

public static bool TryParse(string tripName, out TripName result)

Parameters

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

TryParse(string, bool, out TripName)

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

Declaration

public static bool TryParse(string tripName, bool allowUnparsed, out TripName result)

Parameters

Type	Name	Description
string	tripName	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.
TripName	result	When this method returns, the parsed TripName, 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}/trips/{trip}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(TripName, TripName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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