Enterprise Knowledge Graph v1 API - Class PublicKnowledgeGraphEntityName (1.0.0-beta04) 

public sealed class PublicKnowledgeGraphEntityName : IResourceName, IEquatable<PublicKnowledgeGraphEntityName>

Reference documentation and code samples for the Enterprise Knowledge Graph v1 API class PublicKnowledgeGraphEntityName.

Resource name for the PublicKnowledgeGraphEntity resource.

Inheritance

object > PublicKnowledgeGraphEntityName

Namespace

Google.Cloud.EnterpriseKnowledgeGraph.V1

Assembly

Google.Cloud.EnterpriseKnowledgeGraph.V1.dll

Constructors

PublicKnowledgeGraphEntityName(string, string, string)

public PublicKnowledgeGraphEntityName(string projectId, string locationId, string publicKnowledgeGraphEntityId)

Constructs a new instance of a PublicKnowledgeGraphEntityName class from the component parts of pattern projects/{project}/locations/{location}/publicKnowledgeGraphEntities/{public_knowledge_graph_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.
publicKnowledgeGraphEntityId string

The PublicKnowledgeGraphEntity ID. Must not be null or empty.

Properties

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

PublicKnowledgeGraphEntityId

public string PublicKnowledgeGraphEntityId { get; }

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

Property Value
Type Description
string

Type

public PublicKnowledgeGraphEntityName.ResourceNameType Type { get; }

The PublicKnowledgeGraphEntityName.ResourceNameType of the contained resource name.

Property Value
Type Description
PublicKnowledgeGraphEntityNameResourceNameType

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

Formats the IDs into the string representation of this PublicKnowledgeGraphEntityName with pattern projects/{project}/locations/{location}/publicKnowledgeGraphEntities/{public_knowledge_graph_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.
publicKnowledgeGraphEntityId string

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

The string representation of this PublicKnowledgeGraphEntityName with pattern projects/{project}/locations/{location}/publicKnowledgeGraphEntities/{public_knowledge_graph_entity}.

FormatProjectLocationPublicKnowledgeGraphEntity(string, string, string)

public static string FormatProjectLocationPublicKnowledgeGraphEntity(string projectId, string locationId, string publicKnowledgeGraphEntityId)

Formats the IDs into the string representation of this PublicKnowledgeGraphEntityName with pattern projects/{project}/locations/{location}/publicKnowledgeGraphEntities/{public_knowledge_graph_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.
publicKnowledgeGraphEntityId string

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

The string representation of this PublicKnowledgeGraphEntityName with pattern projects/{project}/locations/{location}/publicKnowledgeGraphEntities/{public_knowledge_graph_entity}.

FromProjectLocationPublicKnowledgeGraphEntity(string, string, string)

public static PublicKnowledgeGraphEntityName FromProjectLocationPublicKnowledgeGraphEntity(string projectId, string locationId, string publicKnowledgeGraphEntityId)

Creates a PublicKnowledgeGraphEntityName with the pattern projects/{project}/locations/{location}/publicKnowledgeGraphEntities/{public_knowledge_graph_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.
publicKnowledgeGraphEntityId string

The PublicKnowledgeGraphEntity ID. Must not be null or empty.
Returns
Type Description
PublicKnowledgeGraphEntityName

A new instance of PublicKnowledgeGraphEntityName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PublicKnowledgeGraphEntityName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PublicKnowledgeGraphEntityName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
publicKnowledgeGraphEntityName string

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

The parsed PublicKnowledgeGraphEntityName if successful.
Remarks

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

  • projects/{project}/locations/{location}/publicKnowledgeGraphEntities/{public_knowledge_graph_entity}

Parse(string, bool)

public static PublicKnowledgeGraphEntityName Parse(string publicKnowledgeGraphEntityName, bool allowUnparsed)

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

Parameters
Name Description
publicKnowledgeGraphEntityName 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
PublicKnowledgeGraphEntityName

The parsed PublicKnowledgeGraphEntityName if successful.
Remarks

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

  • projects/{project}/locations/{location}/publicKnowledgeGraphEntities/{public_knowledge_graph_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 PublicKnowledgeGraphEntityName)

public static bool TryParse(string publicKnowledgeGraphEntityName, out PublicKnowledgeGraphEntityName result)

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

Parameters
Name Description
publicKnowledgeGraphEntityName string

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

When this method returns, the parsed PublicKnowledgeGraphEntityName, 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}/publicKnowledgeGraphEntities/{public_knowledge_graph_entity}

TryParse(string, bool, out PublicKnowledgeGraphEntityName)

public static bool TryParse(string publicKnowledgeGraphEntityName, bool allowUnparsed, out PublicKnowledgeGraphEntityName result)

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

Parameters
Name Description
publicKnowledgeGraphEntityName 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 PublicKnowledgeGraphEntityName

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

Operators

operator ==(PublicKnowledgeGraphEntityName, PublicKnowledgeGraphEntityName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a PublicKnowledgeGraphEntityName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a PublicKnowledgeGraphEntityName

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

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.