public sealed class LakeName : IResourceName, IEquatable<LakeName>
Reference documentation and code samples for the Cloud Dataplex v1 API class LakeName.
Resource name for the Lake
resource.
Namespace
Google.Cloud.Dataplex.V1Assembly
Google.Cloud.Dataplex.V1.dll
Constructors
LakeName(string, string, string)
public LakeName(string projectId, string locationId, string lakeId)
Constructs a new instance of a LakeName class from the component parts of pattern
projects/{project}/locations/{location}/lakes/{lake}
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
lakeId | string The |
Properties
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 LakeName.ResourceNameType Type { get; }
The LakeName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
LakeNameResourceNameType |
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 lakeId)
Formats the IDs into the string representation of this LakeName with pattern
projects/{project}/locations/{location}/lakes/{lake}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
lakeId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this LakeName with pattern
|
FormatProjectLocationLake(string, string, string)
public static string FormatProjectLocationLake(string projectId, string locationId, string lakeId)
Formats the IDs into the string representation of this LakeName with pattern
projects/{project}/locations/{location}/lakes/{lake}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
lakeId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this LakeName with pattern
|
FromProjectLocationLake(string, string, string)
public static LakeName FromProjectLocationLake(string projectId, string locationId, string lakeId)
Creates a LakeName with the pattern projects/{project}/locations/{location}/lakes/{lake}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
lakeId | string The |
Returns | |
---|---|
Type | Description |
LakeName | A new instance of LakeName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static LakeName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a LakeName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName | UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
LakeName | A new instance of LakeName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static LakeName Parse(string lakeName)
Parses the given resource name string into a new LakeName instance.
Parameter | |
---|---|
Name | Description |
lakeName | string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
LakeName | The parsed LakeName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/lakes/{lake}
Parse(string, bool)
public static LakeName Parse(string lakeName, bool allowUnparsed)
Parses the given resource name string into a new LakeName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
lakeName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
LakeName | The parsed LakeName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/lakes/{lake}
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 LakeName)
public static bool TryParse(string lakeName, out LakeName result)
Tries to parse the given resource name string into a new LakeName instance.
Parameters | |
---|---|
Name | Description |
lakeName | string The resource name in string form. Must not be |
result | LakeName When this method returns, the parsed LakeName, 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}
TryParse(string, bool, out LakeName)
public static bool TryParse(string lakeName, bool allowUnparsed, out LakeName result)
Tries to parse the given resource name string into a new LakeName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
lakeName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
result | LakeName When this method returns, the parsed LakeName, 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}
allowUnparsed
is true
.
Operators
operator ==(LakeName, LakeName)
public static bool operator ==(LakeName a, LakeName b)
Parameters | |
---|---|
Name | Description |
a | LakeName |
b | LakeName |
Returns | |
---|---|
Type | Description |
bool |
operator !=(LakeName, LakeName)
public static bool operator !=(LakeName a, LakeName b)
Parameters | |
---|---|
Name | Description |
a | LakeName |
b | LakeName |
Returns | |
---|---|
Type | Description |
bool |