Data Catalog v1 API - Class EntryName (2.3.0)

Version 2.3.0

• 2.13.0 (latest)
• 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.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0

public sealed class EntryName : IResourceName, IEquatable<EntryName>

Reference documentation and code samples for the Data Catalog v1 API class EntryName.

Resource name for the Entry resource.

Inheritance

object > EntryName

Implements

IResourceName, IEquatableEntryName

Inherited Members

object.GetType()

Namespace

GoogleCloudGoogle.Cloud.DataCatalogV1

Assembly

Google.Cloud.DataCatalog.V1.dll

Constructors

EntryName(string, string, string, string)

public EntryName(string projectId, string locationId, string entryGroupId, string entryId)

Constructs a new instance of a EntryName class from the component parts of pattern projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}

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.
entryId	string The Entry 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

EntryId

public string EntryId { get; }

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

The EntryName.ResourceNameType of the contained resource name.

Property Value
Type	Description
EntryNameResourceNameType

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

Formats the IDs into the string representation of this EntryName with pattern projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.

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.
entryId	string The Entry ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this EntryName with pattern projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.

FormatProjectLocationEntryGroupEntry(string, string, string, string)

public static string FormatProjectLocationEntryGroupEntry(string projectId, string locationId, string entryGroupId, string entryId)

Formats the IDs into the string representation of this EntryName with pattern projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.

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.
entryId	string The Entry ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this EntryName with pattern projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.

FromProjectLocationEntryGroupEntry(string, string, string, string)

public static EntryName FromProjectLocationEntryGroupEntry(string projectId, string locationId, string entryGroupId, string entryId)

Creates a EntryName with the pattern projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.

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.
entryId	string The Entry ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static EntryName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EntryName containing an unparsed resource name.

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

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

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

Object.GetHashCode()

Parse(string)

public static EntryName Parse(string entryName)

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

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

Returns
Type	Description
EntryName	The parsed EntryName if successful.

Remarks

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

• projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}

Parse(string, bool)

public static EntryName Parse(string entryName, bool allowUnparsed)

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

Parameters
Name	Description
entryName	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
EntryName	The parsed EntryName if successful.

Remarks

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

• projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}

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

public static bool TryParse(string entryName, out EntryName result)

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

Parameters
Name	Description
entryName	string The resource name in string form. Must not be null.
result	EntryName When this method returns, the parsed EntryName, 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}/entries/{entry}

TryParse(string, bool, out EntryName)

public static bool TryParse(string entryName, bool allowUnparsed, out EntryName result)

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

Parameters
Name	Description
entryName	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	EntryName When this method returns, the parsed EntryName, 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}/entries/{entry}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(EntryName, EntryName)

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

Parameters
Name	Description
a	EntryName
b	EntryName

Returns
Type	Description
bool

operator !=(EntryName, EntryName)

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

Parameters
Name	Description
a	EntryName
b	EntryName

Returns
Type	Description
bool