DataStream v1 API - Class StreamObjectName (2.11.0) 

public sealed class StreamObjectName : IResourceName, IEquatable<StreamObjectName>

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

Resource name for the StreamObject resource.

Inheritance

object > StreamObjectName

Namespace

Google.Cloud.Datastream.V1

Assembly

Google.Cloud.Datastream.V1.dll

Constructors

StreamObjectName(string, string, string, string)

public StreamObjectName(string projectId, string locationId, string streamId, string objectId)

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

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.
objectId string

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

ObjectId

public string ObjectId { get; }

The Object 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 StreamObjectName.ResourceNameType Type { get; }

The StreamObjectName.ResourceNameType of the contained resource name.

Property Value
Type Description
StreamObjectNameResourceNameType

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 streamId, string objectId)

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

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.
objectId string

The Object ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this StreamObjectName with pattern projects/{project}/locations/{location}/streams/{stream}/objects/{object}.

FormatProjectLocationStreamObject(string, string, string, string)

public static string FormatProjectLocationStreamObject(string projectId, string locationId, string streamId, string objectId)

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

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.
objectId string

The Object ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this StreamObjectName with pattern projects/{project}/locations/{location}/streams/{stream}/objects/{object}.

FromProjectLocationStreamObject(string, string, string, string)

public static StreamObjectName FromProjectLocationStreamObject(string projectId, string locationId, string streamId, string objectId)

Creates a StreamObjectName with the pattern projects/{project}/locations/{location}/streams/{stream}/objects/{object}.

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.
objectId string

The Object ID. Must not be null or empty.
Returns
Type Description
StreamObjectName

A new instance of StreamObjectName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static StreamObjectName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a StreamObjectName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of StreamObjectName 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 StreamObjectName Parse(string streamObjectName)

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

Parameter
Name Description
streamObjectName string

The resource name in string form. Must not be null.
Returns
Type Description
StreamObjectName

The parsed StreamObjectName if successful.
Remarks

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

  • projects/{project}/locations/{location}/streams/{stream}/objects/{object}

Parse(string, bool)

public static StreamObjectName Parse(string streamObjectName, bool allowUnparsed)

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

Parameters
Name Description
streamObjectName 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
StreamObjectName

The parsed StreamObjectName if successful.
Remarks

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

  • projects/{project}/locations/{location}/streams/{stream}/objects/{object}
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 StreamObjectName)

public static bool TryParse(string streamObjectName, out StreamObjectName result)

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

Parameters
Name Description
streamObjectName string

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

When this method returns, the parsed StreamObjectName, 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}/objects/{object}

TryParse(string, bool, out StreamObjectName)

public static bool TryParse(string streamObjectName, bool allowUnparsed, out StreamObjectName result)

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

Parameters
Name Description
streamObjectName 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 StreamObjectName

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

Operators

operator ==(StreamObjectName, StreamObjectName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a StreamObjectName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a StreamObjectName

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

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.