Data Catalog v1 API - Class PolicyTagName (2.3.0)

Version 2.3.0

• 2.14.0 (latest)
• 2.13.0
• 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 PolicyTagName : IResourceName, IEquatable<PolicyTagName>

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

Resource name for the PolicyTag resource.

Inheritance

object > PolicyTagName

Implements

IResourceName, IEquatablePolicyTagName

Inherited Members

object.GetType()

Namespace

GoogleCloudGoogle.Cloud.DataCatalogV1

Assembly

Google.Cloud.DataCatalog.V1.dll

Constructors

PolicyTagName(string, string, string, string)

public PolicyTagName(string projectId, string locationId, string taxonomyId, string policyTagId)

Constructs a new instance of a PolicyTagName class from the component parts of pattern projects/{project}/locations/{location}/taxonomies/{taxonomy}/policyTags/{policy_tag}

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.
taxonomyId	string The Taxonomy ID. Must not be null or empty.
policyTagId	string The PolicyTag 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

PolicyTagId

public string PolicyTagId { get; }

The PolicyTag 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

TaxonomyId

public string TaxonomyId { get; }

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

Property Value
Type	Description
string

Type

public PolicyTagName.ResourceNameType Type { get; }

The PolicyTagName.ResourceNameType of the contained resource name.

Property Value
Type	Description
PolicyTagNameResourceNameType

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 taxonomyId, string policyTagId)

Formats the IDs into the string representation of this PolicyTagName with pattern projects/{project}/locations/{location}/taxonomies/{taxonomy}/policyTags/{policy_tag}.

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.
taxonomyId	string The Taxonomy ID. Must not be null or empty.
policyTagId	string The PolicyTag ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this PolicyTagName with pattern projects/{project}/locations/{location}/taxonomies/{taxonomy}/policyTags/{policy_tag}.

FormatProjectLocationTaxonomyPolicyTag(string, string, string, string)

public static string FormatProjectLocationTaxonomyPolicyTag(string projectId, string locationId, string taxonomyId, string policyTagId)

Formats the IDs into the string representation of this PolicyTagName with pattern projects/{project}/locations/{location}/taxonomies/{taxonomy}/policyTags/{policy_tag}.

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.
taxonomyId	string The Taxonomy ID. Must not be null or empty.
policyTagId	string The PolicyTag ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this PolicyTagName with pattern projects/{project}/locations/{location}/taxonomies/{taxonomy}/policyTags/{policy_tag}.

FromProjectLocationTaxonomyPolicyTag(string, string, string, string)

public static PolicyTagName FromProjectLocationTaxonomyPolicyTag(string projectId, string locationId, string taxonomyId, string policyTagId)

Creates a PolicyTagName with the pattern projects/{project}/locations/{location}/taxonomies/{taxonomy}/policyTags/{policy_tag}.

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.
taxonomyId	string The Taxonomy ID. Must not be null or empty.
policyTagId	string The PolicyTag ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static PolicyTagName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PolicyTagName containing an unparsed resource name.

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

Returns
Type	Description
PolicyTagName	A new instance of PolicyTagName 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 PolicyTagName Parse(string policyTagName)

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

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

Returns
Type	Description
PolicyTagName	The parsed PolicyTagName if successful.

Remarks

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

• projects/{project}/locations/{location}/taxonomies/{taxonomy}/policyTags/{policy_tag}

Parse(string, bool)

public static PolicyTagName Parse(string policyTagName, bool allowUnparsed)

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

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

Remarks

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

• projects/{project}/locations/{location}/taxonomies/{taxonomy}/policyTags/{policy_tag}

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

public static bool TryParse(string policyTagName, out PolicyTagName result)

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

Parameters
Name	Description
policyTagName	string The resource name in string form. Must not be null.
result	PolicyTagName When this method returns, the parsed PolicyTagName, 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}/taxonomies/{taxonomy}/policyTags/{policy_tag}

TryParse(string, bool, out PolicyTagName)

public static bool TryParse(string policyTagName, bool allowUnparsed, out PolicyTagName result)

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

Parameters
Name	Description
policyTagName	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	PolicyTagName When this method returns, the parsed PolicyTagName, 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}/taxonomies/{taxonomy}/policyTags/{policy_tag}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(PolicyTagName, PolicyTagName)

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

Parameters
Name	Description
a	PolicyTagName
b	PolicyTagName

Returns
Type	Description
bool

operator !=(PolicyTagName, PolicyTagName)

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

Parameters
Name	Description
a	PolicyTagName
b	PolicyTagName

Returns
Type	Description
bool