Google Cloud Data Loss Prevention v2 API - Class DeidentifyTemplateName (2.16.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

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
bool

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
DeidentifyTemplateNameResourceNameType

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
int
Overrides

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

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

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

  • 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, bool, 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 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 DeidentifyTemplateName

When this method returns, the parsed DeidentifyTemplateName, 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:

  • 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

operator ==(DeidentifyTemplateName, DeidentifyTemplateName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DeidentifyTemplateName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DeidentifyTemplateName

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

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.