Cloud Dataplex v1 API - Class EntityName (3.12.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

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

The EntityName.ResourceNameType of the contained resource name.

Property Value
Type Description
EntityNameResourceNameType

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
int
Overrides

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, bool)

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 bool

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

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
bool

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, bool, 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 bool

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
bool

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

operator ==(EntityName, EntityName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a EntityName

The first resource name to compare, or null.
b EntityName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(EntityName, EntityName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a EntityName

The first resource name to compare, or null.
b EntityName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.