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

Implements

IResourceName, IEquatable<StreamObjectName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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

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

Overrides

Object.GetHashCode()

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

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

Object.ToString()

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
`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}/objects/{object}

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

Or may be in any format if allowUnparsed is true.

Operators

Equality(StreamObjectName, StreamObjectName)

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

Parameters
Name	Description
`a`	`StreamObjectName`
`b`	`StreamObjectName`

Returns
Type	Description
`Boolean`

Inequality(StreamObjectName, StreamObjectName)

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

Parameters
Name	Description
`a`	`StreamObjectName`
`b`	`StreamObjectName`

Returns
Type	Description
`Boolean`