Cloud Dataplex v1 API - Class EntityName (2.2.0)

Version 2.2.0

• 3.4.0 (latest)
• 3.3.0
• 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 EntityName : IResourceName, IEquatable<EntityName>

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

Resource name for the Entity resource.

Inheritance

Object > EntityName

Implements

IResourceName, IEquatable<EntityName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

EntityName(String, String, String, String, String)

public EntityName(string projectId, string locationId, string lakeId, string zoneId, string entityId)

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

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.
entityId	String The Entity ID. Must not be null or empty.

Properties

EntityId

public string EntityId { get; }

The Entity 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
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 EntityName.ResourceNameType Type { get; }

The EntityName.ResourceNameType of the contained resource name.

Property Value
Type	Description
EntityName.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, String)

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

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

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.
entityId	String The Entity ID. Must not be null or empty.

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

FormatProjectLocationLakeZoneEntity(String, String, String, String, String)

public static string FormatProjectLocationLakeZoneEntity(string projectId, string locationId, string lakeId, string zoneId, string entityId)

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

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.
entityId	String The Entity ID. Must not be null or empty.

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

FromProjectLocationLakeZoneEntity(String, String, String, String, String)

public static EntityName FromProjectLocationLakeZoneEntity(string projectId, string locationId, string lakeId, string zoneId, string entityId)

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

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.
entityId	String The Entity ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static EntityName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EntityName containing an unparsed resource name.

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

Returns
Type	Description
EntityName	A new instance of EntityName 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 EntityName Parse(string entityName)

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

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

Returns
Type	Description
EntityName	The parsed EntityName 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}/entities/{entity}

Parse(String, Boolean)

public static EntityName Parse(string entityName, bool allowUnparsed)

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

Parameters
Name	Description
entityName	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
EntityName	The parsed EntityName 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}/entities/{entity}

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 EntityName)

public static bool TryParse(string entityName, out EntityName result)

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

Parameters
Name	Description
entityName	String The resource name in string form. Must not be null.
result	EntityName When this method returns, the parsed EntityName, 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}/entities/{entity}

TryParse(String, Boolean, out EntityName)

public static bool TryParse(string entityName, bool allowUnparsed, out EntityName result)

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

Parameters
Name	Description
entityName	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	EntityName When this method returns, the parsed EntityName, 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}/entities/{entity}

Or may be in any format if allowUnparsed is true.

Operators

Equality(EntityName, EntityName)

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

Parameters
Name	Description
a	EntityName
b	EntityName

Returns
Type	Description
Boolean

Inequality(EntityName, EntityName)

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

Parameters
Name	Description
a	EntityName
b	EntityName

Returns
Type	Description
Boolean