Cloud Dataplex v1 API - Class EntryLinkName (3.10.0)

public sealed class EntryLinkName : IResourceName, IEquatable<EntryLinkName>

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

Resource name for the EntryLink resource.

Inheritance

object > EntryLinkName

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

EntryLinkName(string, string, string, string)

public EntryLinkName(string projectId, string locationId, string entryGroupId, string entryLinkId)

Constructs a new instance of a EntryLinkName class from the component parts of pattern projects/{project}/locations/{location}/entryGroups/{entry_group}/entryLinks/{entry_link}

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.

entryGroupId string

The EntryGroup ID. Must not be null or empty.

entryLinkId string

The EntryLink ID. Must not be null or empty.

Properties

EntryGroupId

public string EntryGroupId { get; }

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

Property Value
Type Description
string

EntryLinkId

public string EntryLinkId { get; }

The EntryLink 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

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

The EntryLinkName.ResourceNameType of the contained resource name.

Property Value
Type Description
EntryLinkNameResourceNameType

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 entryGroupId, string entryLinkId)

Formats the IDs into the string representation of this EntryLinkName with pattern projects/{project}/locations/{location}/entryGroups/{entry_group}/entryLinks/{entry_link}.

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.

entryGroupId string

The EntryGroup ID. Must not be null or empty.

entryLinkId string

The EntryLink ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this EntryLinkName with pattern projects/{project}/locations/{location}/entryGroups/{entry_group}/entryLinks/{entry_link}.

public static string FormatProjectLocationEntryGroupEntryLink(string projectId, string locationId, string entryGroupId, string entryLinkId)

Formats the IDs into the string representation of this EntryLinkName with pattern projects/{project}/locations/{location}/entryGroups/{entry_group}/entryLinks/{entry_link}.

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.

entryGroupId string

The EntryGroup ID. Must not be null or empty.

entryLinkId string

The EntryLink ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this EntryLinkName with pattern projects/{project}/locations/{location}/entryGroups/{entry_group}/entryLinks/{entry_link}.

public static EntryLinkName FromProjectLocationEntryGroupEntryLink(string projectId, string locationId, string entryGroupId, string entryLinkId)

Creates a EntryLinkName with the pattern projects/{project}/locations/{location}/entryGroups/{entry_group}/entryLinks/{entry_link}.

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.

entryGroupId string

The EntryGroup ID. Must not be null or empty.

entryLinkId string

The EntryLink ID. Must not be null or empty.

Returns
Type Description
EntryLinkName

A new instance of EntryLinkName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static EntryLinkName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EntryLinkName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
EntryLinkName

A new instance of EntryLinkName 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 EntryLinkName Parse(string entryLinkName)

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

Parameter
Name Description
entryLinkName string

The resource name in string form. Must not be null.

Returns
Type Description
EntryLinkName

The parsed EntryLinkName if successful.

Remarks

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

  • projects/{project}/locations/{location}/entryGroups/{entry_group}/entryLinks/{entry_link}

Parse(string, bool)

public static EntryLinkName Parse(string entryLinkName, bool allowUnparsed)

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

Parameters
Name Description
entryLinkName 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
EntryLinkName

The parsed EntryLinkName if successful.

Remarks

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

  • projects/{project}/locations/{location}/entryGroups/{entry_group}/entryLinks/{entry_link}
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 EntryLinkName)

public static bool TryParse(string entryLinkName, out EntryLinkName result)

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

Parameters
Name Description
entryLinkName string

The resource name in string form. Must not be null.

result EntryLinkName

When this method returns, the parsed EntryLinkName, 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}/entryGroups/{entry_group}/entryLinks/{entry_link}

TryParse(string, bool, out EntryLinkName)

public static bool TryParse(string entryLinkName, bool allowUnparsed, out EntryLinkName result)

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

Parameters
Name Description
entryLinkName 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 EntryLinkName

When this method returns, the parsed EntryLinkName, 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}/entryGroups/{entry_group}/entryLinks/{entry_link}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(EntryLinkName, EntryLinkName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a EntryLinkName

The first resource name to compare, or null.

b EntryLinkName

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 !=(EntryLinkName, EntryLinkName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a EntryLinkName

The first resource name to compare, or null.

b EntryLinkName

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.