DataStream v1 API - Class StreamName (2.8.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

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

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
StreamNameResourceNameType

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
int
Overrides

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, bool)

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

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
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}/streams/{stream}

TryParse(string, bool, 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 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 StreamName

When this method returns, the parsed StreamName, 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}/streams/{stream}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(StreamName, StreamName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a StreamName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a StreamName

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

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.