Class EnvironmentName (1.0.0) 

public sealed class EnvironmentName : IResourceName, IEquatable<EnvironmentName>

Resource name for the Environment resource.

Inheritance

System.Object > EnvironmentName

Implements

Google.Api.Gax.IResourceName, System.IEquatable<EnvironmentName>

Inherited Members

System.Object.GetType()
System.Object.MemberwiseClone()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

EnvironmentName(String, String, String, String)

public EnvironmentName(string projectId, string locationId, string agentId, string environmentId)

Constructs a new instance of a EnvironmentName class from the component parts of pattern projects/{project}/locations/{location}/agents/{agent}/environments/{environment}

Parameters
Name Description
projectId System.String

The Project ID. Must not be null or empty.
locationId System.String

The Location ID. Must not be null or empty.
agentId System.String

The Agent ID. Must not be null or empty.
environmentId System.String

The Environment ID. Must not be null or empty.

Properties

AgentId

public string AgentId { get; }

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

Property Value
Type Description
System.String

EnvironmentId

public string EnvironmentId { get; }

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

Property Value
Type Description
System.String

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type Description
System.Boolean

LocationId

public string LocationId { get; }

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

Property Value
Type Description
System.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
System.String

Type

public EnvironmentName.ResourceNameType Type { get; }

The EnvironmentName.ResourceNameType of the contained resource name.

Property Value
Type Description
EnvironmentName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
Google.Api.Gax.UnparsedResourceName

Methods

Format(String, String, String, String)

public static string Format(string projectId, string locationId, string agentId, string environmentId)

Formats the IDs into the string representation of this EnvironmentName with pattern projects/{project}/locations/{location}/agents/{agent}/environments/{environment}.

Parameters
Name Description
projectId System.String

The Project ID. Must not be null or empty.
locationId System.String

The Location ID. Must not be null or empty.
agentId System.String

The Agent ID. Must not be null or empty.
environmentId System.String

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

The string representation of this EnvironmentName with pattern projects/{project}/locations/{location}/agents/{agent}/environments/{environment}.

FormatProjectLocationAgentEnvironment(String, String, String, String)

public static string FormatProjectLocationAgentEnvironment(string projectId, string locationId, string agentId, string environmentId)

Formats the IDs into the string representation of this EnvironmentName with pattern projects/{project}/locations/{location}/agents/{agent}/environments/{environment}.

Parameters
Name Description
projectId System.String

The Project ID. Must not be null or empty.
locationId System.String

The Location ID. Must not be null or empty.
agentId System.String

The Agent ID. Must not be null or empty.
environmentId System.String

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

The string representation of this EnvironmentName with pattern projects/{project}/locations/{location}/agents/{agent}/environments/{environment}.

FromProjectLocationAgentEnvironment(String, String, String, String)

public static EnvironmentName FromProjectLocationAgentEnvironment(string projectId, string locationId, string agentId, string environmentId)

Creates a EnvironmentName with the pattern projects/{project}/locations/{location}/agents/{agent}/environments/{environment}.

Parameters
Name Description
projectId System.String

The Project ID. Must not be null or empty.
locationId System.String

The Location ID. Must not be null or empty.
agentId System.String

The Agent ID. Must not be null or empty.
environmentId System.String

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

A new instance of EnvironmentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static EnvironmentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EnvironmentName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName Google.Api.Gax.UnparsedResourceName

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

A new instance of EnvironmentName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()

Parse(String)

public static EnvironmentName Parse(string environmentName)

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

Parameter
Name Description
environmentName System.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:

  • projects/{project}/locations/{location}/agents/{agent}/environments/{environment}

Parse(String, Boolean)

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 System.String

The resource name in string form. Must not be null.
allowUnparsed System.Boolean

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.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:

  • projects/{project}/locations/{location}/agents/{agent}/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
System.String

The string representation of the resource name.
Overrides
System.Object.ToString()

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 System.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
System.Boolean

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}/agents/{agent}/environments/{environment}

TryParse(String, Boolean, 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 System.String

The resource name in string form. Must not be null.
allowUnparsed System.Boolean

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.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
System.Boolean

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}/agents/{agent}/environments/{environment}
Or may be in any format if allowUnparsed is true.

Operators

Equality(EnvironmentName, EnvironmentName)

public static bool operator ==(EnvironmentName a, EnvironmentName b)
Parameters
Name Description
a EnvironmentName
b EnvironmentName
Returns
Type Description
System.Boolean

Inequality(EnvironmentName, EnvironmentName)

public static bool operator !=(EnvironmentName a, EnvironmentName b)
Parameters
Name Description
a EnvironmentName
b EnvironmentName
Returns
Type Description
System.Boolean

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月05日 UTC.