Cloud Shell v1 API - Class EnvironmentName (2.5.0) 

public sealed class EnvironmentName : IResourceName, IEquatable<EnvironmentName>

Reference documentation and code samples for the Cloud Shell v1 API class EnvironmentName.

Resource name for the Environment resource.

Inheritance

object > EnvironmentName

Namespace

Google.Cloud.Shell.V1

Assembly

Google.Cloud.Shell.V1.dll

Constructors

EnvironmentName(string, string)

public EnvironmentName(string userId, string environmentId)

Constructs a new instance of a EnvironmentName class from the component parts of pattern users/{user}/environments/{environment}

Parameters
Name Description
userId string

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

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

Type

public EnvironmentName.ResourceNameType Type { get; }

The EnvironmentName.ResourceNameType of the contained resource name.

Property Value
Type Description
EnvironmentNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

UserId

public string UserId { get; }

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

Property Value
Type Description
string

Methods

Format(string, string)

public static string Format(string userId, string environmentId)

Formats the IDs into the string representation of this EnvironmentName with pattern users/{user}/environments/{environment}.

Parameters
Name Description
userId string

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

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

The string representation of this EnvironmentName with pattern users/{user}/environments/{environment}.

FormatUserEnvironment(string, string)

public static string FormatUserEnvironment(string userId, string environmentId)

Formats the IDs into the string representation of this EnvironmentName with pattern users/{user}/environments/{environment}.

Parameters
Name Description
userId string

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

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

The string representation of this EnvironmentName with pattern users/{user}/environments/{environment}.

FromUnparsed(UnparsedResourceName)

public static EnvironmentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EnvironmentName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of EnvironmentName containing the provided unparsedResourceName.

FromUserEnvironment(string, string)

public static EnvironmentName FromUserEnvironment(string userId, string environmentId)

Creates a EnvironmentName with the pattern users/{user}/environments/{environment}.

Parameters
Name Description
userId string

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

The Environment ID. Must not be null or empty.
Returns
Type Description
EnvironmentName

A new instance of EnvironmentName constructed from the provided ids.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static EnvironmentName Parse(string environmentName)

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

Parameter
Name Description
environmentName string

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

The parsed EnvironmentName if successful.
Remarks

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

  • users/{user}/environments/{environment}

Parse(string, bool)

public static EnvironmentName Parse(string environmentName, bool allowUnparsed)

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

Parameters
Name Description
environmentName 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
EnvironmentName

The parsed EnvironmentName if successful.
Remarks

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

  • users/{user}/environments/{environment}
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 EnvironmentName)

public static bool TryParse(string environmentName, out EnvironmentName result)

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

Parameters
Name Description
environmentName string

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

When this method returns, the parsed EnvironmentName, 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:

  • users/{user}/environments/{environment}

TryParse(string, bool, out EnvironmentName)

public static bool TryParse(string environmentName, bool allowUnparsed, out EnvironmentName result)

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

Parameters
Name Description
environmentName 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 EnvironmentName

When this method returns, the parsed EnvironmentName, 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:

  • users/{user}/environments/{environment}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(EnvironmentName, EnvironmentName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a EnvironmentName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a EnvironmentName

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

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.