DataStream v1 API - Class StreamName (2.2.0)

public sealed class StreamName : IResourceName, IEquatable<StreamName>

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

Resource name for the Stream resource.

Inheritance

Object > StreamName

Implements

IResourceName, IEquatable<StreamName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Datastream.V1

Assembly

Google.Cloud.Datastream.V1.dll

Constructors

StreamName(String, String, String)

public StreamName(string projectId, string locationId, string streamId)

Constructs a new instance of a StreamName class from the component parts of pattern projects/{project}/locations/{location}/streams/{stream}

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.
`streamId`	`String` The `Stream` 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`

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`

StreamId

public string StreamId { get; }

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

Property Value
Type	Description
`String`

Type

public StreamName.ResourceNameType Type { get; }

The StreamName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`StreamName.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)

public static string Format(string projectId, string locationId, string streamId)

Formats the IDs into the string representation of this StreamName with pattern projects/{project}/locations/{location}/streams/{stream}.

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.
`streamId`	`String` The `Stream` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this StreamName with pattern `projects/{project}/locations/{location}/streams/{stream}`.

FormatProjectLocationStream(String, String, String)

public static string FormatProjectLocationStream(string projectId, string locationId, string streamId)

Formats the IDs into the string representation of this StreamName with pattern projects/{project}/locations/{location}/streams/{stream}.

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.
`streamId`	`String` The `Stream` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this StreamName with pattern `projects/{project}/locations/{location}/streams/{stream}`.

FromProjectLocationStream(String, String, String)

public static StreamName FromProjectLocationStream(string projectId, string locationId, string streamId)

Creates a StreamName with the pattern projects/{project}/locations/{location}/streams/{stream}.

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.
`streamId`	`String` The `Stream` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static StreamName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a StreamName containing an unparsed resource name.

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

Returns
Type	Description
`StreamName`	A new instance of StreamName 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 StreamName Parse(string streamName)

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

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

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

Remarks

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

projects/{project}/locations/{location}/streams/{stream}

Parse(String, Boolean)

public static StreamName Parse(string streamName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/streams/{stream}

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

public static bool TryParse(string streamName, out StreamName result)

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

Parameters
Name	Description
`streamName`	`String` The resource name in string form. Must not be `null`.
`result`	`StreamName` When this method returns, the parsed StreamName, 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}/streams/{stream}

TryParse(String, Boolean, out StreamName)

public static bool TryParse(string streamName, bool allowUnparsed, out StreamName result)

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

Parameters
Name	Description
`streamName`	`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`	`StreamName` When this method returns, the parsed StreamName, 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}/streams/{stream}

Or may be in any format if allowUnparsed is true.

Operators

Equality(StreamName, StreamName)

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

Parameters
Name	Description
`a`	`StreamName`
`b`	`StreamName`

Returns
Type	Description
`Boolean`

Inequality(StreamName, StreamName)

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

Parameters
Name	Description
`a`	`StreamName`
`b`	`StreamName`

Returns
Type	Description
`Boolean`