Enterprise Knowledge Graph v1 API - Class CloudKnowledgeGraphEntityName (1.0.0-beta02)

public sealed class CloudKnowledgeGraphEntityName : IResourceName, IEquatable<CloudKnowledgeGraphEntityName>

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

Resource name for the CloudKnowledgeGraphEntity resource.

Inheritance

object > CloudKnowledgeGraphEntityName

Namespace

Google.Cloud.EnterpriseKnowledgeGraph.V1

Assembly

Google.Cloud.EnterpriseKnowledgeGraph.V1.dll

Constructors

CloudKnowledgeGraphEntityName(string, string, string)

public CloudKnowledgeGraphEntityName(string projectId, string locationId, string cloudKnowledgeGraphEntityId)

Constructs a new instance of a CloudKnowledgeGraphEntityName class from the component parts of pattern projects/{project}/locations/{location}/cloudKnowledgeGraphEntities/{cloud_knowledge_graph_entity}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

cloudKnowledgeGraphEntityIdstring

The CloudKnowledgeGraphEntity ID. Must not be null or empty.

Properties

CloudKnowledgeGraphEntityId

public string CloudKnowledgeGraphEntityId { get; }

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

Property Value
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

Type

public CloudKnowledgeGraphEntityName.ResourceNameType Type { get; }

The CloudKnowledgeGraphEntityName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
CloudKnowledgeGraphEntityNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string, string)

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

Formats the IDs into the string representation of this CloudKnowledgeGraphEntityName with pattern projects/{project}/locations/{location}/cloudKnowledgeGraphEntities/{cloud_knowledge_graph_entity}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

cloudKnowledgeGraphEntityIdstring

The CloudKnowledgeGraphEntity ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this CloudKnowledgeGraphEntityName with pattern projects/{project}/locations/{location}/cloudKnowledgeGraphEntities/{cloud_knowledge_graph_entity}.

FormatProjectLocationCloudKnowledgeGraphEntity(string, string, string)

public static string FormatProjectLocationCloudKnowledgeGraphEntity(string projectId, string locationId, string cloudKnowledgeGraphEntityId)

Formats the IDs into the string representation of this CloudKnowledgeGraphEntityName with pattern projects/{project}/locations/{location}/cloudKnowledgeGraphEntities/{cloud_knowledge_graph_entity}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

cloudKnowledgeGraphEntityIdstring

The CloudKnowledgeGraphEntity ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this CloudKnowledgeGraphEntityName with pattern projects/{project}/locations/{location}/cloudKnowledgeGraphEntities/{cloud_knowledge_graph_entity}.

FromProjectLocationCloudKnowledgeGraphEntity(string, string, string)

public static CloudKnowledgeGraphEntityName FromProjectLocationCloudKnowledgeGraphEntity(string projectId, string locationId, string cloudKnowledgeGraphEntityId)

Creates a CloudKnowledgeGraphEntityName with the pattern projects/{project}/locations/{location}/cloudKnowledgeGraphEntities/{cloud_knowledge_graph_entity}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

cloudKnowledgeGraphEntityIdstring

The CloudKnowledgeGraphEntity ID. Must not be null or empty.

Returns
TypeDescription
CloudKnowledgeGraphEntityName

A new instance of CloudKnowledgeGraphEntityName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CloudKnowledgeGraphEntityName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CloudKnowledgeGraphEntityName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
CloudKnowledgeGraphEntityName

A new instance of CloudKnowledgeGraphEntityName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static CloudKnowledgeGraphEntityName Parse(string cloudKnowledgeGraphEntityName)

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

Parameter
NameDescription
cloudKnowledgeGraphEntityNamestring

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

Returns
TypeDescription
CloudKnowledgeGraphEntityName

The parsed CloudKnowledgeGraphEntityName if successful.

Remarks

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

  • projects/{project}/locations/{location}/cloudKnowledgeGraphEntities/{cloud_knowledge_graph_entity}

Parse(string, bool)

public static CloudKnowledgeGraphEntityName Parse(string cloudKnowledgeGraphEntityName, bool allowUnparsed)

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

Parameters
NameDescription
cloudKnowledgeGraphEntityNamestring

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

allowUnparsedbool

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
TypeDescription
CloudKnowledgeGraphEntityName

The parsed CloudKnowledgeGraphEntityName if successful.

Remarks

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

  • projects/{project}/locations/{location}/cloudKnowledgeGraphEntities/{cloud_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
TypeDescription
string

The string representation of the resource name.

Overrides

TryParse(string, out CloudKnowledgeGraphEntityName)

public static bool TryParse(string cloudKnowledgeGraphEntityName, out CloudKnowledgeGraphEntityName result)

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

Parameters
NameDescription
cloudKnowledgeGraphEntityNamestring

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

resultCloudKnowledgeGraphEntityName

When this method returns, the parsed CloudKnowledgeGraphEntityName, or null if parsing failed.

Returns
TypeDescription
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}/cloudKnowledgeGraphEntities/{cloud_knowledge_graph_entity}

TryParse(string, bool, out CloudKnowledgeGraphEntityName)

public static bool TryParse(string cloudKnowledgeGraphEntityName, bool allowUnparsed, out CloudKnowledgeGraphEntityName result)

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

Parameters
NameDescription
cloudKnowledgeGraphEntityNamestring

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

allowUnparsedbool

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.

resultCloudKnowledgeGraphEntityName

When this method returns, the parsed CloudKnowledgeGraphEntityName, or null if parsing failed.

Returns
TypeDescription
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}/cloudKnowledgeGraphEntities/{cloud_knowledge_graph_entity}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(CloudKnowledgeGraphEntityName, CloudKnowledgeGraphEntityName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aCloudKnowledgeGraphEntityName

The first resource name to compare, or null.

bCloudKnowledgeGraphEntityName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(CloudKnowledgeGraphEntityName, CloudKnowledgeGraphEntityName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aCloudKnowledgeGraphEntityName

The first resource name to compare, or null.

bCloudKnowledgeGraphEntityName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.