Google Cloud Dataproc v1 API - Class SessionTemplateName (5.9.0)

public sealed class SessionTemplateName : IResourceName, IEquatable<SessionTemplateName>

Reference documentation and code samples for the Google Cloud Dataproc v1 API class SessionTemplateName.

Resource name for the SessionTemplate resource.

Inheritance

object > SessionTemplateName

Implements

IResourceName, IEquatable SessionTemplateName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dataproc.V1

Assembly

Google.Cloud.Dataproc.V1.dll

Constructors

SessionTemplateName(string, string, string)

public SessionTemplateName(string projectId, string locationId, string templateId)

Constructs a new instance of a SessionTemplateName class from the component parts of pattern projects/{project}/locations/{location}/sessionTemplates/{template}

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.
`templateId`	`string` The `Template` 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`

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`

TemplateId

public string TemplateId { get; }

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

Property Value
Type	Description
`string`

Type

public SessionTemplateName.ResourceNameType Type { get; }

The SessionTemplateName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`SessionTemplateNameResourceNameType`

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)

public static string Format(string projectId, string locationId, string templateId)

Formats the IDs into the string representation of this SessionTemplateName with pattern projects/{project}/locations/{location}/sessionTemplates/{template}.

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.
`templateId`	`string` The `Template` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SessionTemplateName with pattern `projects/{project}/locations/{location}/sessionTemplates/{template}`.

FormatProjectLocationTemplate(string, string, string)

public static string FormatProjectLocationTemplate(string projectId, string locationId, string templateId)

Formats the IDs into the string representation of this SessionTemplateName with pattern projects/{project}/locations/{location}/sessionTemplates/{template}.

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.
`templateId`	`string` The `Template` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SessionTemplateName with pattern `projects/{project}/locations/{location}/sessionTemplates/{template}`.

FromProjectLocationTemplate(string, string, string)

public static SessionTemplateName FromProjectLocationTemplate(string projectId, string locationId, string templateId)

Creates a SessionTemplateName with the pattern projects/{project}/locations/{location}/sessionTemplates/{template}.

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.
`templateId`	`string` The `Template` ID. Must not be `null` or empty.

Returns
Type	Description
`SessionTemplateName`	A new instance of SessionTemplateName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SessionTemplateName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SessionTemplateName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`SessionTemplateName`	A new instance of SessionTemplateName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static SessionTemplateName Parse(string sessionTemplateName)

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

Parameter
Name	Description
`sessionTemplateName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`SessionTemplateName`	The parsed SessionTemplateName if successful.

Remarks

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

projects/{project}/locations/{location}/sessionTemplates/{template}

Parse(string, bool)

public static SessionTemplateName Parse(string sessionTemplateName, bool allowUnparsed)

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

Parameters
Name	Description
`sessionTemplateName`	`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
`SessionTemplateName`	The parsed SessionTemplateName if successful.

Remarks

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

projects/{project}/locations/{location}/sessionTemplates/{template}

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 SessionTemplateName)

public static bool TryParse(string sessionTemplateName, out SessionTemplateName result)

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

Parameters
Name	Description
`sessionTemplateName`	`string` The resource name in string form. Must not be `null`.
`result`	`SessionTemplateName` When this method returns, the parsed SessionTemplateName, 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}/sessionTemplates/{template}

TryParse(string, bool, out SessionTemplateName)

public static bool TryParse(string sessionTemplateName, bool allowUnparsed, out SessionTemplateName result)

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

Parameters
Name	Description
`sessionTemplateName`	`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`	`SessionTemplateName` When this method returns, the parsed SessionTemplateName, 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}/sessionTemplates/{template}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SessionTemplateName, SessionTemplateName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`SessionTemplateName` The first resource name to compare, or null.
`b`	`SessionTemplateName` 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 !=(SessionTemplateName, SessionTemplateName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`SessionTemplateName` The first resource name to compare, or null.
`b`	`SessionTemplateName` 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.