Google Cloud Dataproc v1 API - Class SessionTemplateName (5.10.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

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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

templateIdstring

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
TypeDescription
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

TemplateId

public string TemplateId { get; }

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

Property Value
TypeDescription
string

Type

public SessionTemplateName.ResourceNameType Type { get; }

The SessionTemplateName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
SessionTemplateNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

templateIdstring

The Template ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

templateIdstring

The Template ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

templateIdstring

The Template ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
SessionTemplateName

A new instance of SessionTemplateName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static SessionTemplateName Parse(string sessionTemplateName)

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

Parameter
NameDescription
sessionTemplateNamestring

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

Returns
TypeDescription
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
NameDescription
sessionTemplateNamestring

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

allowUnparsedbool

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
TypeDescription
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
TypeDescription
string

The string representation of the resource name.

Overrides

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
NameDescription
sessionTemplateNamestring

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

resultSessionTemplateName

When this method returns, the parsed SessionTemplateName, or null if parsing failed.

Returns
TypeDescription
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
NameDescription
sessionTemplateNamestring

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

allowUnparsedbool

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.

resultSessionTemplateName

When this method returns, the parsed SessionTemplateName, or null if parsing failed.

Returns
TypeDescription
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
NameDescription
aSessionTemplateName

The first resource name to compare, or null.

bSessionTemplateName

The second resource name to compare, or null.

Returns
TypeDescription
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
NameDescription
aSessionTemplateName

The first resource name to compare, or null.

bSessionTemplateName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.