DataStream v1 API - Class RouteName (2.2.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

Implements

IResourceName, IEquatable<RouteName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
`Boolean`

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
`RouteName.ResourceNameType`

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
`Int32`

Overrides

Object.GetHashCode()

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, 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
Name	Description
`routeName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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

Object.ToString()

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
`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
Name	Description
`routeName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
`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
Name	Description
`a`	`RouteName`
`b`	`RouteName`

Returns
Type	Description
`Boolean`

Inequality(RouteName, RouteName)

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

Parameters
Name	Description
`a`	`RouteName`
`b`	`RouteName`

Returns
Type	Description
`Boolean`