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

Implements

IResourceName, IEquatable<InspectTemplateName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.
`inspectTemplateId`	`String` 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
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 InspectTemplateName.ResourceNameType Type { get; }

The InspectTemplateName.ResourceNameType of the contained resource name.

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

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

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

Returns
Type	Description
`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
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.
`inspectTemplateId`	`String` The `InspectTemplate` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.
`locationId`	`String` The `Location` ID. Must not be `null` or empty.
`inspectTemplateId`	`String` The `InspectTemplate` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`inspectTemplateId`	`String` The `InspectTemplate` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`locationId`	`String` The `Location` ID. Must not be `null` or empty.
`inspectTemplateId`	`String` The `InspectTemplate` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.
`inspectTemplateId`	`String` The `InspectTemplate` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.
`locationId`	`String` The `Location` ID. Must not be `null` or empty.
`inspectTemplateId`	`String` The `InspectTemplate` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`inspectTemplateId`	`String` The `InspectTemplate` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`locationId`	`String` The `Location` ID. Must not be `null` or empty.
`inspectTemplateId`	`String` The `InspectTemplate` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

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

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

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

Returns
Type	Description
`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, Boolean)

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
Name	Description
`inspectTemplateName`	`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
`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
Type	Description
`String`	The string representation of the resource name.

Overrides

Object.ToString()

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
Name	Description
`inspectTemplateName`	`String` The resource name in string form. Must not be `null`.
`result`	`InspectTemplateName` When this method returns, the parsed InspectTemplateName, 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}/inspectTemplates/{inspect_template}
projects/{project}/inspectTemplates/{inspect_template}
organizations/{organization}/locations/{location}/inspectTemplates/{inspect_template}
projects/{project}/locations/{location}/inspectTemplates/{inspect_template}

TryParse(String, Boolean, 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
Name	Description
`inspectTemplateName`	`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`	`InspectTemplateName` When this method returns, the parsed InspectTemplateName, 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}/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

Equality(InspectTemplateName, InspectTemplateName)

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

Parameters
Name	Description
`a`	`InspectTemplateName`
`b`	`InspectTemplateName`

Returns
Type	Description
`Boolean`

Inequality(InspectTemplateName, InspectTemplateName)

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

Parameters
Name	Description
`a`	`InspectTemplateName`
`b`	`InspectTemplateName`

Returns
Type	Description
`Boolean`