Class EntryGroupName (2.1.0) 

public sealed class EntryGroupName : IResourceName, IEquatable<EntryGroupName>

Resource name for the EntryGroup resource.

Inheritance

Object > EntryGroupName

Namespace

Google.Cloud.DataCatalog.V1

Assembly

Google.Cloud.DataCatalog.V1.dll

Constructors

EntryGroupName(String, String, String)

public EntryGroupName(string projectId, string locationId, string entryGroupId)

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

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.

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

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type Description
Boolean

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

The EntryGroupName.ResourceNameType of the contained resource name.

Property Value
Type Description
EntryGroupName.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

Methods

Format(String, String, String)

public static string Format(string projectId, string locationId, string entryGroupId)

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

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.
Returns
Type Description
String

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

FormatProjectLocationEntryGroup(String, String, String)

public static string FormatProjectLocationEntryGroup(string projectId, string locationId, string entryGroupId)

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

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.
Returns
Type Description
String

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

FromProjectLocationEntryGroup(String, String, String)

public static EntryGroupName FromProjectLocationEntryGroup(string projectId, string locationId, string entryGroupId)

Creates a EntryGroupName with the pattern projects/{project}/locations/{location}/entryGroups/{entry_group}.

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.
Returns
Type Description
EntryGroupName

A new instance of EntryGroupName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static EntryGroupName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EntryGroupName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
EntryGroupName

A new instance of EntryGroupName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
Int32
Overrides

Parse(String)

public static EntryGroupName Parse(string entryGroupName)

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

Parameter
Name Description
entryGroupName String

The resource name in string form. Must not be null.
Returns
Type Description
EntryGroupName

The parsed EntryGroupName if successful.
Remarks

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

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

Parse(String, Boolean)

public static EntryGroupName Parse(string entryGroupName, bool allowUnparsed)

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

Parameters
Name Description
entryGroupName 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
EntryGroupName

The parsed EntryGroupName if successful.
Remarks

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

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

public static bool TryParse(string entryGroupName, out EntryGroupName result)

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

Parameters
Name Description
entryGroupName String

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

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

TryParse(String, Boolean, out EntryGroupName)

public static bool TryParse(string entryGroupName, bool allowUnparsed, out EntryGroupName result)

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

Parameters
Name Description
entryGroupName 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 EntryGroupName

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

Operators

Equality(EntryGroupName, EntryGroupName)

public static bool operator ==(EntryGroupName a, EntryGroupName b)
Parameters
Name Description
a EntryGroupName
b EntryGroupName
Returns
Type Description
Boolean

Inequality(EntryGroupName, EntryGroupName)

public static bool operator !=(EntryGroupName a, EntryGroupName b)
Parameters
Name Description
a EntryGroupName
b EntryGroupName
Returns
Type Description
Boolean