Data Catalog v1 API - Class PolicyTagName (2.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, IEquatable<PolicyTagName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.DataCatalog.V1

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
`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`

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
`PolicyTagName.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, 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
`Int32`

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, Boolean)

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`	`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
`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
`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}/taxonomies/{taxonomy}/policyTags/{policy_tag}

TryParse(String, Boolean, 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`	`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`	`PolicyTagName` When this method returns, the parsed PolicyTagName, 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}/taxonomies/{taxonomy}/policyTags/{policy_tag}

Or may be in any format if allowUnparsed is true.

Operators

Equality(PolicyTagName, PolicyTagName)

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

Parameters
Name	Description
`a`	`PolicyTagName`
`b`	`PolicyTagName`

Returns
Type	Description
`Boolean`

Inequality(PolicyTagName, PolicyTagName)

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

Parameters
Name	Description
`a`	`PolicyTagName`
`b`	`PolicyTagName`

Returns
Type	Description
`Boolean`