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

public sealed class StoredInfoTypeName : IResourceName, IEquatable<StoredInfoTypeName>

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

Resource name for the StoredInfoType resource.

Inheritance

object > StoredInfoTypeName

Implements

IResourceName, IEquatable StoredInfoTypeName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dlp.V2

Assembly

Google.Cloud.Dlp.V2.dll

Constructors

StoredInfoTypeName(string, string)

public StoredInfoTypeName(string organizationId, string storedInfoTypeId)

Constructs a new instance of a StoredInfoTypeName class from the component parts of pattern organizations/{organization}/storedInfoTypes/{stored_info_type}

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`storedInfoTypeId`	`string` The `StoredInfoType` 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
`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`

StoredInfoTypeId

public string StoredInfoTypeId { get; }

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

Property Value
Type	Description
`string`

Type

public StoredInfoTypeName.ResourceNameType Type { get; }

The StoredInfoTypeName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`StoredInfoTypeNameResourceNameType`

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

Formats the IDs into the string representation of this StoredInfoTypeName with pattern organizations/{organization}/storedInfoTypes/{stored_info_type}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`storedInfoTypeId`	`string` The `StoredInfoType` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this StoredInfoTypeName with pattern `organizations/{organization}/storedInfoTypes/{stored_info_type}`.

FormatOrganizationLocationStoredInfoType(string, string, string)

public static string FormatOrganizationLocationStoredInfoType(string organizationId, string locationId, string storedInfoTypeId)

Formats the IDs into the string representation of this StoredInfoTypeName with pattern organizations/{organization}/locations/{location}/storedInfoTypes/{stored_info_type}.

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.
`storedInfoTypeId`	`string` The `StoredInfoType` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this StoredInfoTypeName with pattern `organizations/{organization}/locations/{location}/storedInfoTypes/{stored_info_type}`.

FormatOrganizationStoredInfoType(string, string)

public static string FormatOrganizationStoredInfoType(string organizationId, string storedInfoTypeId)

Formats the IDs into the string representation of this StoredInfoTypeName with pattern organizations/{organization}/storedInfoTypes/{stored_info_type}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`storedInfoTypeId`	`string` The `StoredInfoType` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this StoredInfoTypeName with pattern `organizations/{organization}/storedInfoTypes/{stored_info_type}`.

FormatProjectLocationStoredInfoType(string, string, string)

public static string FormatProjectLocationStoredInfoType(string projectId, string locationId, string storedInfoTypeId)

Formats the IDs into the string representation of this StoredInfoTypeName with pattern projects/{project}/locations/{location}/storedInfoTypes/{stored_info_type}.

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.
`storedInfoTypeId`	`string` The `StoredInfoType` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this StoredInfoTypeName with pattern `projects/{project}/locations/{location}/storedInfoTypes/{stored_info_type}`.

FormatProjectStoredInfoType(string, string)

public static string FormatProjectStoredInfoType(string projectId, string storedInfoTypeId)

Formats the IDs into the string representation of this StoredInfoTypeName with pattern projects/{project}/storedInfoTypes/{stored_info_type}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`storedInfoTypeId`	`string` The `StoredInfoType` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this StoredInfoTypeName with pattern `projects/{project}/storedInfoTypes/{stored_info_type}`.

FromOrganizationLocationStoredInfoType(string, string, string)

public static StoredInfoTypeName FromOrganizationLocationStoredInfoType(string organizationId, string locationId, string storedInfoTypeId)

Creates a StoredInfoTypeName with the pattern organizations/{organization}/locations/{location}/storedInfoTypes/{stored_info_type}.

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.
`storedInfoTypeId`	`string` The `StoredInfoType` ID. Must not be `null` or empty.

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

FromOrganizationStoredInfoType(string, string)

public static StoredInfoTypeName FromOrganizationStoredInfoType(string organizationId, string storedInfoTypeId)

Creates a StoredInfoTypeName with the pattern organizations/{organization}/storedInfoTypes/{stored_info_type}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`storedInfoTypeId`	`string` The `StoredInfoType` ID. Must not be `null` or empty.

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

FromProjectLocationStoredInfoType(string, string, string)

public static StoredInfoTypeName FromProjectLocationStoredInfoType(string projectId, string locationId, string storedInfoTypeId)

Creates a StoredInfoTypeName with the pattern projects/{project}/locations/{location}/storedInfoTypes/{stored_info_type}.

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.
`storedInfoTypeId`	`string` The `StoredInfoType` ID. Must not be `null` or empty.

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

FromProjectStoredInfoType(string, string)

public static StoredInfoTypeName FromProjectStoredInfoType(string projectId, string storedInfoTypeId)

Creates a StoredInfoTypeName with the pattern projects/{project}/storedInfoTypes/{stored_info_type}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`storedInfoTypeId`	`string` The `StoredInfoType` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static StoredInfoTypeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a StoredInfoTypeName containing an unparsed resource name.

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

Returns
Type	Description
`StoredInfoTypeName`	A new instance of StoredInfoTypeName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static StoredInfoTypeName Parse(string storedInfoTypeName)

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

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

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

Remarks

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

organizations/{organization}/storedInfoTypes/{stored_info_type}
projects/{project}/storedInfoTypes/{stored_info_type}
organizations/{organization}/locations/{location}/storedInfoTypes/{stored_info_type}
projects/{project}/locations/{location}/storedInfoTypes/{stored_info_type}

Parse(string, bool)

public static StoredInfoTypeName Parse(string storedInfoTypeName, bool allowUnparsed)

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

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

Remarks

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

organizations/{organization}/storedInfoTypes/{stored_info_type}
projects/{project}/storedInfoTypes/{stored_info_type}
organizations/{organization}/locations/{location}/storedInfoTypes/{stored_info_type}
projects/{project}/locations/{location}/storedInfoTypes/{stored_info_type}

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

public static bool TryParse(string storedInfoTypeName, out StoredInfoTypeName result)

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

Parameters
Name	Description
`storedInfoTypeName`	`string` The resource name in string form. Must not be `null`.
`result`	`StoredInfoTypeName` When this method returns, the parsed StoredInfoTypeName, 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}/storedInfoTypes/{stored_info_type}
projects/{project}/storedInfoTypes/{stored_info_type}
organizations/{organization}/locations/{location}/storedInfoTypes/{stored_info_type}
projects/{project}/locations/{location}/storedInfoTypes/{stored_info_type}

TryParse(string, bool, out StoredInfoTypeName)

public static bool TryParse(string storedInfoTypeName, bool allowUnparsed, out StoredInfoTypeName result)

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

Parameters
Name	Description
`storedInfoTypeName`	`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`	`StoredInfoTypeName` When this method returns, the parsed StoredInfoTypeName, 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}/storedInfoTypes/{stored_info_type}
projects/{project}/storedInfoTypes/{stored_info_type}
organizations/{organization}/locations/{location}/storedInfoTypes/{stored_info_type}
projects/{project}/locations/{location}/storedInfoTypes/{stored_info_type}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(StoredInfoTypeName, StoredInfoTypeName)

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

Parameters
Name	Description
`a`	`StoredInfoTypeName`
`b`	`StoredInfoTypeName`

Returns
Type	Description
`bool`

operator !=(StoredInfoTypeName, StoredInfoTypeName)

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

Parameters
Name	Description
`a`	`StoredInfoTypeName`
`b`	`StoredInfoTypeName`

Returns
Type	Description
`bool`