DataStream v1 API - Class RouteName (2.8.0) 

public sealed class RouteName : IResourceName, IEquatable<RouteName>

Reference documentation and code samples for the DataStream v1 API class RouteName.

Resource name for the Route resource.

Inheritance

object > RouteName

Namespace

Google.Cloud.Datastream.V1

Assembly

Google.Cloud.Datastream.V1.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
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
privateConnectionId string

The PrivateConnection ID. Must not be null or empty.
routeId string

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
Type Description
bool

LocationId

public string LocationId { get; }

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

Property Value
Type Description
string

PrivateConnectionId

public string PrivateConnectionId { get; }

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

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

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

Property Value
Type Description
string

RouteId

public string RouteId { get; }

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

Property Value
Type Description
string

Type

public RouteName.ResourceNameType Type { get; }

The RouteName.ResourceNameType of the contained resource name.

Property Value
Type Description
RouteNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
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
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
privateConnectionId string

The PrivateConnection ID. Must not be null or empty.
routeId string

The Route ID. Must not be null or empty.
Returns
Type Description
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
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
privateConnectionId string

The PrivateConnection ID. Must not be null or empty.
routeId string

The Route ID. Must not be null or empty.
Returns
Type Description
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
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
privateConnectionId string

The PrivateConnection ID. Must not be null or empty.
routeId string

The Route ID. Must not be null or empty.
Returns
Type Description
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
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
RouteName

A new instance of RouteName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static RouteName Parse(string routeName)

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

Parameter
Name Description
routeName string

The resource name in string form. Must not be null.
Returns
Type Description
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, bool)

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
Name Description
routeName string

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

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
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
Type Description
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
Name Description
routeName string

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

When this method returns, the parsed RouteName, 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:

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

TryParse(string, bool, 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
Name Description
routeName string

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

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.
result RouteName

When this method returns, the parsed RouteName, 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:

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

Operators

operator ==(RouteName, RouteName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RouteName

The first resource name to compare, or null.
b RouteName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RouteName

The first resource name to compare, or null.
b RouteName

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.