public sealed class StreamObjectName : IResourceName, IEquatable<StreamObjectName>
Resource name for the StreamObject
resource.
Namespace
Google.Cloud.Datastream.V1Assembly
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 |
locationId | String The |
streamId | String The |
objectId | String The |
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 |
locationId | String The |
streamId | String The |
objectId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this StreamObjectName with pattern
|
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 |
locationId | String The |
streamId | String The |
objectId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this StreamObjectName with pattern
|
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 |
locationId | String The |
streamId | String The |
objectId | String The |
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 |
Returns | |
---|---|
Type | Description |
StreamObjectName | A new instance of StreamObjectName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
Int32 |
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 |
Returns | |
---|---|
Type | Description |
StreamObjectName | The parsed StreamObjectName if successful. |
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 |
allowUnparsed | Boolean If |
Returns | |
---|---|
Type | Description |
StreamObjectName | The parsed StreamObjectName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/streams/{stream}/objects/{object}
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. |
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 |
result | StreamObjectName When this method returns, the parsed StreamObjectName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
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 |
allowUnparsed | Boolean If |
result | StreamObjectName When this method returns, the parsed StreamObjectName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/streams/{stream}/objects/{object}
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 |