Cloud Dataplex v1 API - Class SessionName (3.1.0) 

public sealed class SessionName : IResourceName, IEquatable<SessionName>

Reference documentation and code samples for the Cloud Dataplex v1 API class SessionName.

Resource name for the Session resource.

Inheritance

object > SessionName

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

SessionName(string, string, string, string, string)

public SessionName(string projectId, string locationId, string lakeId, string environmentId, string sessionId)

Constructs a new instance of a SessionName class from the component parts of pattern projects/{project}/locations/{location}/lakes/{lake}/environments/{environment}/sessions/{session}

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

The Lake ID. Must not be null or empty.
environmentId string

The Environment ID. Must not be null or empty.
sessionId string

The Session ID. Must not be null or empty.

Properties

EnvironmentId

public string EnvironmentId { get; }

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

LakeId

public string LakeId { get; }

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

Property Value
Type Description
string

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

SessionId

public string SessionId { get; }

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

Property Value
Type Description
string

Type

public SessionName.ResourceNameType Type { get; }

The SessionName.ResourceNameType of the contained resource name.

Property Value
Type Description
SessionNameResourceNameType

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

public static string Format(string projectId, string locationId, string lakeId, string environmentId, string sessionId)

Formats the IDs into the string representation of this SessionName with pattern projects/{project}/locations/{location}/lakes/{lake}/environments/{environment}/sessions/{session}.

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

The Lake ID. Must not be null or empty.
environmentId string

The Environment ID. Must not be null or empty.
sessionId string

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

The string representation of this SessionName with pattern projects/{project}/locations/{location}/lakes/{lake}/environments/{environment}/sessions/{session}.

FormatProjectLocationLakeEnvironmentSession(string, string, string, string, string)

public static string FormatProjectLocationLakeEnvironmentSession(string projectId, string locationId, string lakeId, string environmentId, string sessionId)

Formats the IDs into the string representation of this SessionName with pattern projects/{project}/locations/{location}/lakes/{lake}/environments/{environment}/sessions/{session}.

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

The Lake ID. Must not be null or empty.
environmentId string

The Environment ID. Must not be null or empty.
sessionId string

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

The string representation of this SessionName with pattern projects/{project}/locations/{location}/lakes/{lake}/environments/{environment}/sessions/{session}.

FromProjectLocationLakeEnvironmentSession(string, string, string, string, string)

public static SessionName FromProjectLocationLakeEnvironmentSession(string projectId, string locationId, string lakeId, string environmentId, string sessionId)

Creates a SessionName with the pattern projects/{project}/locations/{location}/lakes/{lake}/environments/{environment}/sessions/{session}.

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

The Lake ID. Must not be null or empty.
environmentId string

The Environment ID. Must not be null or empty.
sessionId string

The Session ID. Must not be null or empty.
Returns
Type Description
SessionName

A new instance of SessionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SessionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SessionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
sessionName string

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

The parsed SessionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/lakes/{lake}/environments/{environment}/sessions/{session}

Parse(string, bool)

public static SessionName Parse(string sessionName, bool allowUnparsed)

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

Parameters
Name Description
sessionName 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
SessionName

The parsed SessionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/lakes/{lake}/environments/{environment}/sessions/{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 SessionName)

public static bool TryParse(string sessionName, out SessionName result)

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

Parameters
Name Description
sessionName string

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

When this method returns, the parsed SessionName, 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}/lakes/{lake}/environments/{environment}/sessions/{session}

TryParse(string, bool, out SessionName)

public static bool TryParse(string sessionName, bool allowUnparsed, out SessionName result)

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

Parameters
Name Description
sessionName 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 SessionName

When this method returns, the parsed SessionName, 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}/lakes/{lake}/environments/{environment}/sessions/{session}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(SessionName, SessionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SessionName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SessionName

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

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.