Cloud Dataplex v1 API - Class EntryTypeName (3.0.0) 

public sealed class EntryTypeName : IResourceName, IEquatable<EntryTypeName>

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

Resource name for the EntryType resource.

Inheritance

object > EntryTypeName

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

EntryTypeName(string, string, string)

public EntryTypeName(string projectId, string locationId, string entryTypeId)

Constructs a new instance of a EntryTypeName class from the component parts of pattern projects/{project}/locations/{location}/entryTypes/{entry_type}

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.
entryTypeId string

The EntryType ID. Must not be null or empty.

Properties

EntryTypeId

public string EntryTypeId { get; }

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

The EntryTypeName.ResourceNameType of the contained resource name.

Property Value
Type Description
EntryTypeNameResourceNameType

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

Formats the IDs into the string representation of this EntryTypeName with pattern projects/{project}/locations/{location}/entryTypes/{entry_type}.

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.
entryTypeId string

The EntryType ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this EntryTypeName with pattern projects/{project}/locations/{location}/entryTypes/{entry_type}.

FormatProjectLocationEntryType(string, string, string)

public static string FormatProjectLocationEntryType(string projectId, string locationId, string entryTypeId)

Formats the IDs into the string representation of this EntryTypeName with pattern projects/{project}/locations/{location}/entryTypes/{entry_type}.

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.
entryTypeId string

The EntryType ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this EntryTypeName with pattern projects/{project}/locations/{location}/entryTypes/{entry_type}.

FromProjectLocationEntryType(string, string, string)

public static EntryTypeName FromProjectLocationEntryType(string projectId, string locationId, string entryTypeId)

Creates a EntryTypeName with the pattern projects/{project}/locations/{location}/entryTypes/{entry_type}.

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.
entryTypeId string

The EntryType ID. Must not be null or empty.
Returns
Type Description
EntryTypeName

A new instance of EntryTypeName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static EntryTypeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EntryTypeName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
entryTypeName string

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

The parsed EntryTypeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/entryTypes/{entry_type}

Parse(string, bool)

public static EntryTypeName Parse(string entryTypeName, bool allowUnparsed)

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

Parameters
Name Description
entryTypeName 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
EntryTypeName

The parsed EntryTypeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/entryTypes/{entry_type}
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 EntryTypeName)

public static bool TryParse(string entryTypeName, out EntryTypeName result)

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

Parameters
Name Description
entryTypeName string

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

When this method returns, the parsed EntryTypeName, 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}/entryTypes/{entry_type}

TryParse(string, bool, out EntryTypeName)

public static bool TryParse(string entryTypeName, bool allowUnparsed, out EntryTypeName result)

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

Parameters
Name Description
entryTypeName 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 EntryTypeName

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

Operators

operator ==(EntryTypeName, EntryTypeName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a EntryTypeName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a EntryTypeName

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

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.