Cloud Dataplex v1 API - Class ZoneName (2.2.0)

Version 2.2.0

• 3.3.0 (latest)
• 3.2.0
• 3.1.0
• 3.0.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.0.0

public sealed class ZoneName : IResourceName, IEquatable<ZoneName>

Reference documentation and code samples for the Cloud Dataplex v1 API class ZoneName.

Resource name for the Zone resource.

Inheritance

Object > ZoneName

Implements

IResourceName, IEquatable<ZoneName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

ZoneName(String, String, String, String)

public ZoneName(string projectId, string locationId, string lakeId, string zoneId)

Constructs a new instance of a ZoneName class from the component parts of pattern projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}

Parameters
Name	Description
projectId	String The Project ID. Must not be null or empty.
locationId	String The Location ID. Must not be null or empty.
lakeId	String The Lake ID. Must not be null or empty.
zoneId	String The Zone 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
Type	Description
Boolean

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 ZoneName.ResourceNameType Type { get; }

The ZoneName.ResourceNameType of the contained resource name.

Property Value
Type	Description
ZoneName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type	Description
UnparsedResourceName

ZoneId

public string ZoneId { get; }

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

Property Value
Type	Description
String

Methods

Format(String, String, String, String)

public static string Format(string projectId, string locationId, string lakeId, string zoneId)

Formats the IDs into the string representation of this ZoneName with pattern projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}.

Parameters
Name	Description
projectId	String The Project ID. Must not be null or empty.
locationId	String The Location ID. Must not be null or empty.
lakeId	String The Lake ID. Must not be null or empty.
zoneId	String The Zone ID. Must not be null or empty.

Returns
Type	Description
String	The string representation of this ZoneName with pattern projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}.

FormatProjectLocationLakeZone(String, String, String, String)

public static string FormatProjectLocationLakeZone(string projectId, string locationId, string lakeId, string zoneId)

Formats the IDs into the string representation of this ZoneName with pattern projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}.

Parameters
Name	Description
projectId	String The Project ID. Must not be null or empty.
locationId	String The Location ID. Must not be null or empty.
lakeId	String The Lake ID. Must not be null or empty.
zoneId	String The Zone ID. Must not be null or empty.

Returns
Type	Description
String	The string representation of this ZoneName with pattern projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}.

FromProjectLocationLakeZone(String, String, String, String)

public static ZoneName FromProjectLocationLakeZone(string projectId, string locationId, string lakeId, string zoneId)

Creates a ZoneName with the pattern projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}.

Parameters
Name	Description
projectId	String The Project ID. Must not be null or empty.
locationId	String The Location ID. Must not be null or empty.
lakeId	String The Lake ID. Must not be null or empty.
zoneId	String The Zone ID. Must not be null or empty.

Returns
Type	Description
ZoneName	A new instance of ZoneName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ZoneName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ZoneName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
ZoneName	A new instance of ZoneName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
Int32

Overrides

Object.GetHashCode()

Parse(String)

public static ZoneName Parse(string zoneName)

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

Parameter
Name	Description
zoneName	String The resource name in string form. Must not be null.

Returns
Type	Description
ZoneName	The parsed ZoneName if successful.

Remarks

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

• projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}

Parse(String, Boolean)

public static ZoneName Parse(string zoneName, bool allowUnparsed)

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

Parameters
Name	Description
zoneName	String The resource name in string form. Must not be null.
allowUnparsed	Boolean 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
ZoneName	The parsed ZoneName if successful.

Remarks

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

• projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}

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

Object.ToString()

TryParse(String, out ZoneName)

public static bool TryParse(string zoneName, out ZoneName result)

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

Parameters
Name	Description
zoneName	String The resource name in string form. Must not be null.
result	ZoneName When this method returns, the parsed ZoneName, or null if parsing failed.

Returns
Type	Description
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}/lakes/{lake}/zones/{zone}

TryParse(String, Boolean, out ZoneName)

public static bool TryParse(string zoneName, bool allowUnparsed, out ZoneName result)

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

Parameters
Name	Description
zoneName	String The resource name in string form. Must not be null.
allowUnparsed	Boolean 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	ZoneName When this method returns, the parsed ZoneName, or null if parsing failed.

Returns
Type	Description
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}/lakes/{lake}/zones/{zone}

Or may be in any format if allowUnparsed is true.

Operators

Equality(ZoneName, ZoneName)

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

Parameters
Name	Description
a	ZoneName
b	ZoneName

Returns
Type	Description
Boolean

Inequality(ZoneName, ZoneName)

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

Parameters
Name	Description
a	ZoneName
b	ZoneName

Returns
Type	Description
Boolean