Google Cloud Data Loss Prevention v2 API - Class DeidentifyTemplateName (4.3.0)

public sealed class DeidentifyTemplateName : IResourceName, IEquatable<DeidentifyTemplateName>

Reference documentation and code samples for the Google Cloud Data Loss Prevention v2 API class DeidentifyTemplateName.

Resource name for the DeidentifyTemplate resource.

Inheritance

Object > DeidentifyTemplateName

Implements

IResourceName, IEquatable<DeidentifyTemplateName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Dlp.V2

Assembly

Google.Cloud.Dlp.V2.dll

Constructors

DeidentifyTemplateName(String, String)

public DeidentifyTemplateName(string organizationId, string deidentifyTemplateId)

Constructs a new instance of a DeidentifyTemplateName class from the component parts of pattern organizations/{organization}/deidentifyTemplates/{deidentify_template}

Parameters
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.
`deidentifyTemplateId`	`String` The `DeidentifyTemplate` ID. Must not be `null` or empty.

Properties

DeidentifyTemplateId

public string DeidentifyTemplateId { get; }

The DeidentifyTemplate ID. May be null, depending on which resource name is contained by this instance.

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

LocationId

public string LocationId { get; }

The Location ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`String`

OrganizationId

public string OrganizationId { get; }

The Organization ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`String`

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`String`

Type

public DeidentifyTemplateName.ResourceNameType Type { get; }

The DeidentifyTemplateName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`DeidentifyTemplateName.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)

public static string Format(string organizationId, string deidentifyTemplateId)

Formats the IDs into the string representation of this DeidentifyTemplateName with pattern organizations/{organization}/deidentifyTemplates/{deidentify_template}.

Parameters
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.
`deidentifyTemplateId`	`String` The `DeidentifyTemplate` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this DeidentifyTemplateName with pattern `organizations/{organization}/deidentifyTemplates/{deidentify_template}`.

FormatOrganizationDeidentifyTemplate(String, String)

public static string FormatOrganizationDeidentifyTemplate(string organizationId, string deidentifyTemplateId)

Formats the IDs into the string representation of this DeidentifyTemplateName with pattern organizations/{organization}/deidentifyTemplates/{deidentify_template}.

Parameters
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.
`deidentifyTemplateId`	`String` The `DeidentifyTemplate` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this DeidentifyTemplateName with pattern `organizations/{organization}/deidentifyTemplates/{deidentify_template}`.

FormatOrganizationLocationDeidentifyTemplate(String, String, String)

public static string FormatOrganizationLocationDeidentifyTemplate(string organizationId, string locationId, string deidentifyTemplateId)

Formats the IDs into the string representation of this DeidentifyTemplateName with pattern organizations/{organization}/locations/{location}/deidentifyTemplates/{deidentify_template}.

Parameters
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.
`locationId`	`String` The `Location` ID. Must not be `null` or empty.
`deidentifyTemplateId`	`String` The `DeidentifyTemplate` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this DeidentifyTemplateName with pattern `organizations/{organization}/locations/{location}/deidentifyTemplates/{deidentify_template}`.

FormatProjectDeidentifyTemplate(String, String)

public static string FormatProjectDeidentifyTemplate(string projectId, string deidentifyTemplateId)

Formats the IDs into the string representation of this DeidentifyTemplateName with pattern projects/{project}/deidentifyTemplates/{deidentify_template}.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`deidentifyTemplateId`	`String` The `DeidentifyTemplate` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this DeidentifyTemplateName with pattern `projects/{project}/deidentifyTemplates/{deidentify_template}`.

FormatProjectLocationDeidentifyTemplate(String, String, String)

public static string FormatProjectLocationDeidentifyTemplate(string projectId, string locationId, string deidentifyTemplateId)

Formats the IDs into the string representation of this DeidentifyTemplateName with pattern projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}.

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.
`deidentifyTemplateId`	`String` The `DeidentifyTemplate` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this DeidentifyTemplateName with pattern `projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}`.

FromOrganizationDeidentifyTemplate(String, String)

public static DeidentifyTemplateName FromOrganizationDeidentifyTemplate(string organizationId, string deidentifyTemplateId)

Creates a DeidentifyTemplateName with the pattern organizations/{organization}/deidentifyTemplates/{deidentify_template}.

Parameters
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.
`deidentifyTemplateId`	`String` The `DeidentifyTemplate` ID. Must not be `null` or empty.

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

FromOrganizationLocationDeidentifyTemplate(String, String, String)

public static DeidentifyTemplateName FromOrganizationLocationDeidentifyTemplate(string organizationId, string locationId, string deidentifyTemplateId)

Creates a DeidentifyTemplateName with the pattern organizations/{organization}/locations/{location}/deidentifyTemplates/{deidentify_template}.

Parameters
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.
`locationId`	`String` The `Location` ID. Must not be `null` or empty.
`deidentifyTemplateId`	`String` The `DeidentifyTemplate` ID. Must not be `null` or empty.

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

FromProjectDeidentifyTemplate(String, String)

public static DeidentifyTemplateName FromProjectDeidentifyTemplate(string projectId, string deidentifyTemplateId)

Creates a DeidentifyTemplateName with the pattern projects/{project}/deidentifyTemplates/{deidentify_template}.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`deidentifyTemplateId`	`String` The `DeidentifyTemplate` ID. Must not be `null` or empty.

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

FromProjectLocationDeidentifyTemplate(String, String, String)

public static DeidentifyTemplateName FromProjectLocationDeidentifyTemplate(string projectId, string locationId, string deidentifyTemplateId)

Creates a DeidentifyTemplateName with the pattern projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}.

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.
`deidentifyTemplateId`	`String` The `DeidentifyTemplate` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static DeidentifyTemplateName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DeidentifyTemplateName containing an unparsed resource name.

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

Returns
Type	Description
`DeidentifyTemplateName`	A new instance of DeidentifyTemplateName 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 DeidentifyTemplateName Parse(string deidentifyTemplateName)

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

Parameter
Name	Description
`deidentifyTemplateName`	`String` The resource name in string form. Must not be `null`.

Returns
Type	Description
`DeidentifyTemplateName`	The parsed DeidentifyTemplateName if successful.

Remarks

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

organizations/{organization}/deidentifyTemplates/{deidentify_template}
projects/{project}/deidentifyTemplates/{deidentify_template}
organizations/{organization}/locations/{location}/deidentifyTemplates/{deidentify_template}
projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

Parse(String, Boolean)

public static DeidentifyTemplateName Parse(string deidentifyTemplateName, bool allowUnparsed)

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

Parameters
Name	Description
`deidentifyTemplateName`	`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
`DeidentifyTemplateName`	The parsed DeidentifyTemplateName if successful.

Remarks

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

organizations/{organization}/deidentifyTemplates/{deidentify_template}
projects/{project}/deidentifyTemplates/{deidentify_template}
organizations/{organization}/locations/{location}/deidentifyTemplates/{deidentify_template}
projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

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

public static bool TryParse(string deidentifyTemplateName, out DeidentifyTemplateName result)

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

Parameters
Name	Description
`deidentifyTemplateName`	`String` The resource name in string form. Must not be `null`.
`result`	`DeidentifyTemplateName` When this method returns, the parsed DeidentifyTemplateName, 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:

organizations/{organization}/deidentifyTemplates/{deidentify_template}
projects/{project}/deidentifyTemplates/{deidentify_template}
organizations/{organization}/locations/{location}/deidentifyTemplates/{deidentify_template}
projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

TryParse(String, Boolean, out DeidentifyTemplateName)

public static bool TryParse(string deidentifyTemplateName, bool allowUnparsed, out DeidentifyTemplateName result)

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

Parameters
Name	Description
`deidentifyTemplateName`	`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`	`DeidentifyTemplateName` When this method returns, the parsed DeidentifyTemplateName, 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:

organizations/{organization}/deidentifyTemplates/{deidentify_template}
projects/{project}/deidentifyTemplates/{deidentify_template}
organizations/{organization}/locations/{location}/deidentifyTemplates/{deidentify_template}
projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

Or may be in any format if allowUnparsed is true.

Operators

Equality(DeidentifyTemplateName, DeidentifyTemplateName)

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

Parameters
Name	Description
`a`	`DeidentifyTemplateName`
`b`	`DeidentifyTemplateName`

Returns
Type	Description
`Boolean`

Inequality(DeidentifyTemplateName, DeidentifyTemplateName)

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

Parameters
Name	Description
`a`	`DeidentifyTemplateName`
`b`	`DeidentifyTemplateName`

Returns
Type	Description
`Boolean`