Class RouteName (2.0.0-alpha01)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class RouteName : IResourceName, IEquatable<RouteName>

Resource name for the Route resource.

Inheritance

Object > RouteName

Namespace

Google.Cloud.Datastream.V1Alpha1

Assembly

Google.Cloud.Datastream.V1Alpha1.dll

Constructors

RouteName(String, String, String, String)

public RouteName(string projectId, string locationId, string privateConnectionId, string routeId)

Constructs a new instance of a RouteName class from the component parts of pattern projects/{project}/locations/{location}/privateConnections/{private_connection}/routes/{route}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

privateConnectionIdString

The PrivateConnection ID. Must not be null or empty.

routeIdString

The Route ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

PrivateConnectionId

public string PrivateConnectionId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

RouteId

public string RouteId { get; }

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

Property Value
TypeDescription
String

Type

public RouteName.ResourceNameType Type { get; }

The RouteName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
RouteName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(String, String, String, String)

public static string Format(string projectId, string locationId, string privateConnectionId, string routeId)

Formats the IDs into the string representation of this RouteName with pattern projects/{project}/locations/{location}/privateConnections/{private_connection}/routes/{route}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

privateConnectionIdString

The PrivateConnection ID. Must not be null or empty.

routeIdString

The Route ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this RouteName with pattern projects/{project}/locations/{location}/privateConnections/{private_connection}/routes/{route}.

FormatProjectLocationPrivateConnectionRoute(String, String, String, String)

public static string FormatProjectLocationPrivateConnectionRoute(string projectId, string locationId, string privateConnectionId, string routeId)

Formats the IDs into the string representation of this RouteName with pattern projects/{project}/locations/{location}/privateConnections/{private_connection}/routes/{route}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

privateConnectionIdString

The PrivateConnection ID. Must not be null or empty.

routeIdString

The Route ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this RouteName with pattern projects/{project}/locations/{location}/privateConnections/{private_connection}/routes/{route}.

FromProjectLocationPrivateConnectionRoute(String, String, String, String)

public static RouteName FromProjectLocationPrivateConnectionRoute(string projectId, string locationId, string privateConnectionId, string routeId)

Creates a RouteName with the pattern projects/{project}/locations/{location}/privateConnections/{private_connection}/routes/{route}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

privateConnectionIdString

The PrivateConnection ID. Must not be null or empty.

routeIdString

The Route ID. Must not be null or empty.

Returns
TypeDescription
RouteName

A new instance of RouteName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RouteName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RouteName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
RouteName

A new instance of RouteName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static RouteName Parse(string routeName)

Parses the given resource name string into a new RouteName instance.

Parameter
NameDescription
routeNameString

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

Returns
TypeDescription
RouteName

The parsed RouteName if successful.

Remarks

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

  • projects/{project}/locations/{location}/privateConnections/{private_connection}/routes/{route}

Parse(String, Boolean)

public static RouteName Parse(string routeName, bool allowUnparsed)

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

Parameters
NameDescription
routeNameString

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

allowUnparsedBoolean

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
TypeDescription
RouteName

The parsed RouteName if successful.

Remarks

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

  • projects/{project}/locations/{location}/privateConnections/{private_connection}/routes/{route}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
String

The string representation of the resource name.

Overrides

TryParse(String, out RouteName)

public static bool TryParse(string routeName, out RouteName result)

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

Parameters
NameDescription
routeNameString

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

resultRouteName

When this method returns, the parsed RouteName, or null if parsing failed.

Returns
TypeDescription
Boolean

true if the name was parsed successfully; false otherwise.

Remarks

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

  • projects/{project}/locations/{location}/privateConnections/{private_connection}/routes/{route}

TryParse(String, Boolean, out RouteName)

public static bool TryParse(string routeName, bool allowUnparsed, out RouteName result)

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

Parameters
NameDescription
routeNameString

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

allowUnparsedBoolean

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.

resultRouteName

When this method returns, the parsed RouteName, or null if parsing failed.

Returns
TypeDescription
Boolean

true if the name was parsed successfully; false otherwise.

Remarks

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

  • projects/{project}/locations/{location}/privateConnections/{private_connection}/routes/{route}
Or may be in any format if allowUnparsed is true.

Operators

Equality(RouteName, RouteName)

public static bool operator ==(RouteName a, RouteName b)
Parameters
NameDescription
aRouteName
bRouteName
Returns
TypeDescription
Boolean

Inequality(RouteName, RouteName)

public static bool operator !=(RouteName a, RouteName b)
Parameters
NameDescription
aRouteName
bRouteName
Returns
TypeDescription
Boolean