Device Streaming v1 API - Class DeviceSessionName (1.0.0-beta01) 

public sealed class DeviceSessionName : IResourceName, IEquatable<DeviceSessionName>

Reference documentation and code samples for the Device Streaming v1 API class DeviceSessionName.

Resource name for the DeviceSession resource.

Inheritance

object > DeviceSessionName

Namespace

Google.Cloud.DeviceStreaming.V1

Assembly

Google.Cloud.DeviceStreaming.V1.dll

Constructors

DeviceSessionName(string, string)

public DeviceSessionName(string projectId, string deviceSessionId)

Constructs a new instance of a DeviceSessionName class from the component parts of pattern projects/{project}/deviceSessions/{device_session}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
deviceSessionId string

The DeviceSession ID. Must not be null or empty.

Properties

DeviceSessionId

public string DeviceSessionId { get; }

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

Property Value
Type Description
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type Description
bool

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

Type

public DeviceSessionName.ResourceNameType Type { get; }

The DeviceSessionName.ResourceNameType of the contained resource name.

Property Value
Type Description
DeviceSessionNameResourceNameType

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)

public static string Format(string projectId, string deviceSessionId)

Formats the IDs into the string representation of this DeviceSessionName with pattern projects/{project}/deviceSessions/{device_session}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
deviceSessionId string

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

The string representation of this DeviceSessionName with pattern projects/{project}/deviceSessions/{device_session}.

FormatProjectDeviceSession(string, string)

public static string FormatProjectDeviceSession(string projectId, string deviceSessionId)

Formats the IDs into the string representation of this DeviceSessionName with pattern projects/{project}/deviceSessions/{device_session}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
deviceSessionId string

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

The string representation of this DeviceSessionName with pattern projects/{project}/deviceSessions/{device_session}.

FromProjectDeviceSession(string, string)

public static DeviceSessionName FromProjectDeviceSession(string projectId, string deviceSessionId)

Creates a DeviceSessionName with the pattern projects/{project}/deviceSessions/{device_session}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
deviceSessionId string

The DeviceSession ID. Must not be null or empty.
Returns
Type Description
DeviceSessionName

A new instance of DeviceSessionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DeviceSessionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DeviceSessionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
deviceSessionName string

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

The parsed DeviceSessionName if successful.
Remarks

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

  • projects/{project}/deviceSessions/{device_session}

Parse(string, bool)

public static DeviceSessionName Parse(string deviceSessionName, bool allowUnparsed)

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

Parameters
Name Description
deviceSessionName 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
DeviceSessionName

The parsed DeviceSessionName if successful.
Remarks

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

  • projects/{project}/deviceSessions/{device_session}
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 DeviceSessionName)

public static bool TryParse(string deviceSessionName, out DeviceSessionName result)

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

Parameters
Name Description
deviceSessionName string

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

When this method returns, the parsed DeviceSessionName, 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}/deviceSessions/{device_session}

TryParse(string, bool, out DeviceSessionName)

public static bool TryParse(string deviceSessionName, bool allowUnparsed, out DeviceSessionName result)

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

Parameters
Name Description
deviceSessionName 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 DeviceSessionName

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

Operators

operator ==(DeviceSessionName, DeviceSessionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DeviceSessionName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DeviceSessionName

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

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.