DataStream v1 API - Class NetworksName (2.5.0)

public sealed class NetworksName : IResourceName, IEquatable<NetworksName>

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

Resource name for the Networks resource.

Inheritance

object > NetworksName

Implements

IResourceName, IEquatable NetworksName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Datastream.V1

Assembly

Google.Cloud.Datastream.V1.dll

Constructors

NetworksName(string, string)

public NetworksName(string projectId, string networkId)

Constructs a new instance of a NetworksName class from the component parts of pattern projects/{project}/global/networks/{network}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`networkId`	`string` The `Network` 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`

NetworkId

public string NetworkId { get; }

The Network 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`

Type

public NetworksName.ResourceNameType Type { get; }

The NetworksName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`NetworksNameResourceNameType`

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)

public static string Format(string projectId, string networkId)

Formats the IDs into the string representation of this NetworksName with pattern projects/{project}/global/networks/{network}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`networkId`	`string` The `Network` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this NetworksName with pattern `projects/{project}/global/networks/{network}`.

FormatProjectNetwork(string, string)

public static string FormatProjectNetwork(string projectId, string networkId)

Formats the IDs into the string representation of this NetworksName with pattern projects/{project}/global/networks/{network}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`networkId`	`string` The `Network` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this NetworksName with pattern `projects/{project}/global/networks/{network}`.

FromProjectNetwork(string, string)

public static NetworksName FromProjectNetwork(string projectId, string networkId)

Creates a NetworksName with the pattern projects/{project}/global/networks/{network}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`networkId`	`string` The `Network` ID. Must not be `null` or empty.

Returns
Type	Description
`NetworksName`	A new instance of NetworksName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static NetworksName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a NetworksName containing an unparsed resource name.

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

Returns
Type	Description
`NetworksName`	A new instance of NetworksName containing the provided `unparsedResourceName` .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static NetworksName Parse(string networksName)

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

Parameter
Name	Description
`networksName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`NetworksName`	The parsed NetworksName if successful.

Remarks

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

projects/{project}/global/networks/{network}

Parse(string, bool)

public static NetworksName Parse(string networksName, bool allowUnparsed)

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

Parameters
Name	Description
`networksName`	`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
`NetworksName`	The parsed NetworksName if successful.

Remarks

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

projects/{project}/global/networks/{network}

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

public static bool TryParse(string networksName, out NetworksName result)

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

Parameters
Name	Description
`networksName`	`string` The resource name in string form. Must not be `null`.
`result`	`NetworksName` When this method returns, the parsed NetworksName, 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}/global/networks/{network}

TryParse(string, bool, out NetworksName)

public static bool TryParse(string networksName, bool allowUnparsed, out NetworksName result)

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

Parameters
Name	Description
`networksName`	`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`	`NetworksName` When this method returns, the parsed NetworksName, 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}/global/networks/{network}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(NetworksName, NetworksName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`NetworksName` The first resource name to compare, or null.
`b`	`NetworksName` 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.