Google Cloud Data Loss Prevention v2 API - Class InspectTemplateName (4.6.0)

public sealed class InspectTemplateName : IResourceName, IEquatable<InspectTemplateName>

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

Resource name for the InspectTemplate resource.

Inheritance

object > InspectTemplateName

Namespace

Google.Cloud.Dlp.V2

Assembly

Google.Cloud.Dlp.V2.dll

Constructors

InspectTemplateName(string, string)

public InspectTemplateName(string organizationId, string inspectTemplateId)

Constructs a new instance of a InspectTemplateName class from the component parts of pattern organizations/{organization}/inspectTemplates/{inspect_template}

Parameters
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

inspectTemplateIdstring

The InspectTemplate ID. Must not be null or empty.

Properties

InspectTemplateId

public string InspectTemplateId { get; }

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

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. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
string

OrganizationId

public string OrganizationId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

Type

public InspectTemplateName.ResourceNameType Type { get; }

The InspectTemplateName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
InspectTemplateNameResourceNameType

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)

public static string Format(string organizationId, string inspectTemplateId)

Formats the IDs into the string representation of this InspectTemplateName with pattern organizations/{organization}/inspectTemplates/{inspect_template}.

Parameters
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

inspectTemplateIdstring

The InspectTemplate ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this InspectTemplateName with pattern organizations/{organization}/inspectTemplates/{inspect_template}.

FormatOrganizationInspectTemplate(string, string)

public static string FormatOrganizationInspectTemplate(string organizationId, string inspectTemplateId)

Formats the IDs into the string representation of this InspectTemplateName with pattern organizations/{organization}/inspectTemplates/{inspect_template}.

Parameters
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

inspectTemplateIdstring

The InspectTemplate ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this InspectTemplateName with pattern organizations/{organization}/inspectTemplates/{inspect_template}.

FormatOrganizationLocationInspectTemplate(string, string, string)

public static string FormatOrganizationLocationInspectTemplate(string organizationId, string locationId, string inspectTemplateId)

Formats the IDs into the string representation of this InspectTemplateName with pattern organizations/{organization}/locations/{location}/inspectTemplates/{inspect_template}.

Parameters
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

inspectTemplateIdstring

The InspectTemplate ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this InspectTemplateName with pattern organizations/{organization}/locations/{location}/inspectTemplates/{inspect_template}.

FormatProjectInspectTemplate(string, string)

public static string FormatProjectInspectTemplate(string projectId, string inspectTemplateId)

Formats the IDs into the string representation of this InspectTemplateName with pattern projects/{project}/inspectTemplates/{inspect_template}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

inspectTemplateIdstring

The InspectTemplate ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this InspectTemplateName with pattern projects/{project}/inspectTemplates/{inspect_template}.

FormatProjectLocationInspectTemplate(string, string, string)

public static string FormatProjectLocationInspectTemplate(string projectId, string locationId, string inspectTemplateId)

Formats the IDs into the string representation of this InspectTemplateName with pattern projects/{project}/locations/{location}/inspectTemplates/{inspect_template}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

inspectTemplateIdstring

The InspectTemplate ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this InspectTemplateName with pattern projects/{project}/locations/{location}/inspectTemplates/{inspect_template}.

FromOrganizationInspectTemplate(string, string)

public static InspectTemplateName FromOrganizationInspectTemplate(string organizationId, string inspectTemplateId)

Creates a InspectTemplateName with the pattern organizations/{organization}/inspectTemplates/{inspect_template}.

Parameters
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

inspectTemplateIdstring

The InspectTemplate ID. Must not be null or empty.

Returns
TypeDescription
InspectTemplateName

A new instance of InspectTemplateName constructed from the provided ids.

FromOrganizationLocationInspectTemplate(string, string, string)

public static InspectTemplateName FromOrganizationLocationInspectTemplate(string organizationId, string locationId, string inspectTemplateId)

Creates a InspectTemplateName with the pattern organizations/{organization}/locations/{location}/inspectTemplates/{inspect_template}.

Parameters
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

inspectTemplateIdstring

The InspectTemplate ID. Must not be null or empty.

Returns
TypeDescription
InspectTemplateName

A new instance of InspectTemplateName constructed from the provided ids.

FromProjectInspectTemplate(string, string)

public static InspectTemplateName FromProjectInspectTemplate(string projectId, string inspectTemplateId)

Creates a InspectTemplateName with the pattern projects/{project}/inspectTemplates/{inspect_template}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

inspectTemplateIdstring

The InspectTemplate ID. Must not be null or empty.

Returns
TypeDescription
InspectTemplateName

A new instance of InspectTemplateName constructed from the provided ids.

FromProjectLocationInspectTemplate(string, string, string)

public static InspectTemplateName FromProjectLocationInspectTemplate(string projectId, string locationId, string inspectTemplateId)

Creates a InspectTemplateName with the pattern projects/{project}/locations/{location}/inspectTemplates/{inspect_template}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

inspectTemplateIdstring

The InspectTemplate ID. Must not be null or empty.

Returns
TypeDescription
InspectTemplateName

A new instance of InspectTemplateName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static InspectTemplateName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a InspectTemplateName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
InspectTemplateName

A new instance of InspectTemplateName 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 InspectTemplateName Parse(string inspectTemplateName)

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

Parameter
NameDescription
inspectTemplateNamestring

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

Returns
TypeDescription
InspectTemplateName

The parsed InspectTemplateName if successful.

Remarks

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

  • organizations/{organization}/inspectTemplates/{inspect_template}
  • projects/{project}/inspectTemplates/{inspect_template}
  • organizations/{organization}/locations/{location}/inspectTemplates/{inspect_template}
  • projects/{project}/locations/{location}/inspectTemplates/{inspect_template}

Parse(string, bool)

public static InspectTemplateName Parse(string inspectTemplateName, bool allowUnparsed)

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

Parameters
NameDescription
inspectTemplateNamestring

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
InspectTemplateName

The parsed InspectTemplateName if successful.

Remarks

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

  • organizations/{organization}/inspectTemplates/{inspect_template}
  • projects/{project}/inspectTemplates/{inspect_template}
  • organizations/{organization}/locations/{location}/inspectTemplates/{inspect_template}
  • projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
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 InspectTemplateName)

public static bool TryParse(string inspectTemplateName, out InspectTemplateName result)

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

Parameters
NameDescription
inspectTemplateNamestring

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

resultInspectTemplateName

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

  • organizations/{organization}/inspectTemplates/{inspect_template}
  • projects/{project}/inspectTemplates/{inspect_template}
  • organizations/{organization}/locations/{location}/inspectTemplates/{inspect_template}
  • projects/{project}/locations/{location}/inspectTemplates/{inspect_template}

TryParse(string, bool, out InspectTemplateName)

public static bool TryParse(string inspectTemplateName, bool allowUnparsed, out InspectTemplateName result)

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

Parameters
NameDescription
inspectTemplateNamestring

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.

resultInspectTemplateName

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

  • organizations/{organization}/inspectTemplates/{inspect_template}
  • projects/{project}/inspectTemplates/{inspect_template}
  • organizations/{organization}/locations/{location}/inspectTemplates/{inspect_template}
  • projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(InspectTemplateName, InspectTemplateName)

public static bool operator ==(InspectTemplateName a, InspectTemplateName b)
Parameters
NameDescription
aInspectTemplateName
bInspectTemplateName
Returns
TypeDescription
bool

operator !=(InspectTemplateName, InspectTemplateName)

public static bool operator !=(InspectTemplateName a, InspectTemplateName b)
Parameters
NameDescription
aInspectTemplateName
bInspectTemplateName
Returns
TypeDescription
bool