public sealed class EnvironmentName : IResourceName, IEquatable<EnvironmentName>
Reference documentation and code samples for the Cloud Dataplex v1 API class EnvironmentName.
Resource name for the Environment
resource.
Namespace
Google.Cloud.Dataplex.V1Assembly
Google.Cloud.Dataplex.V1.dll
Constructors
EnvironmentName(string, string, string, string)
public EnvironmentName(string projectId, string locationId, string lakeId, string environmentId)
Constructs a new instance of a EnvironmentName class from the component parts of pattern
projects/{project}/locations/{location}/lakes/{lake}/environments/{environment}
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
lakeId | string The |
environmentId | string The |
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 |
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 |
Methods
Format(string, string, string, string)
public static string Format(string projectId, string locationId, string lakeId, string environmentId)
Formats the IDs into the string representation of this EnvironmentName with pattern
projects/{project}/locations/{location}/lakes/{lake}/environments/{environment}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
lakeId | string The |
environmentId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this EnvironmentName with pattern
|
FormatProjectLocationLakeEnvironment(string, string, string, string)
public static string FormatProjectLocationLakeEnvironment(string projectId, string locationId, string lakeId, string environmentId)
Formats the IDs into the string representation of this EnvironmentName with pattern
projects/{project}/locations/{location}/lakes/{lake}/environments/{environment}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
lakeId | string The |
environmentId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this EnvironmentName with pattern
|
FromProjectLocationLakeEnvironment(string, string, string, string)
public static EnvironmentName FromProjectLocationLakeEnvironment(string projectId, string locationId, string lakeId, string environmentId)
Creates a EnvironmentName with the pattern
projects/{project}/locations/{location}/lakes/{lake}/environments/{environment}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
lakeId | string The |
environmentId | string The |
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 | UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
EnvironmentName | A new instance of EnvironmentName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
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 |
Returns | |
---|---|
Type | Description |
EnvironmentName | The parsed EnvironmentName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/lakes/{lake}/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 |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
EnvironmentName | The parsed EnvironmentName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/lakes/{lake}/environments/{environment}
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. |
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 |
result | EnvironmentName When this method returns, the parsed EnvironmentName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/lakes/{lake}/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 |
allowUnparsed | bool If |
result | EnvironmentName When this method returns, the parsed EnvironmentName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/lakes/{lake}/environments/{environment}
allowUnparsed
is true
.
Operators
operator ==(EnvironmentName, EnvironmentName)
public static bool operator ==(EnvironmentName a, EnvironmentName b)
Parameters | |
---|---|
Name | Description |
a | EnvironmentName |
b | EnvironmentName |
Returns | |
---|---|
Type | Description |
bool |
operator !=(EnvironmentName, EnvironmentName)
public static bool operator !=(EnvironmentName a, EnvironmentName b)
Parameters | |
---|---|
Name | Description |
a | EnvironmentName |
b | EnvironmentName |
Returns | |
---|---|
Type | Description |
bool |