Google Cloud Data Loss Prevention v2 API - Class ProjectDataProfileName (4.12.0)

public sealed class ProjectDataProfileName : IResourceName, IEquatable<ProjectDataProfileName>

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

Resource name for the ProjectDataProfile resource.

Inheritance

object > ProjectDataProfileName

Implements

IResourceName, IEquatable ProjectDataProfileName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dlp.V2

Assembly

Google.Cloud.Dlp.V2.dll

Constructors

ProjectDataProfileName(string, string, string)

public ProjectDataProfileName(string organizationId, string locationId, string projectDataProfileId)

Constructs a new instance of a ProjectDataProfileName class from the component parts of pattern organizations/{organization}/locations/{location}/projectDataProfiles/{project_data_profile}

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.
`projectDataProfileId`	`string` The `ProjectDataProfile` 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`

ProjectDataProfileId

public string ProjectDataProfileId { get; }

The ProjectDataProfile 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 ProjectDataProfileName.ResourceNameType Type { get; }

The ProjectDataProfileName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ProjectDataProfileNameResourceNameType`

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

public static string Format(string organizationId, string locationId, string projectDataProfileId)

Formats the IDs into the string representation of this ProjectDataProfileName with pattern organizations/{organization}/locations/{location}/projectDataProfiles/{project_data_profile}.

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

Returns
Type	Description
`string`	The string representation of this ProjectDataProfileName with pattern `organizations/{organization}/locations/{location}/projectDataProfiles/{project_data_profile}`.

FormatOrganizationLocationProjectDataProfile(string, string, string)

public static string FormatOrganizationLocationProjectDataProfile(string organizationId, string locationId, string projectDataProfileId)

Formats the IDs into the string representation of this ProjectDataProfileName with pattern organizations/{organization}/locations/{location}/projectDataProfiles/{project_data_profile}.

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

Returns
Type	Description
`string`	The string representation of this ProjectDataProfileName with pattern `organizations/{organization}/locations/{location}/projectDataProfiles/{project_data_profile}`.

FormatProjectLocationProjectDataProfile(string, string, string)

public static string FormatProjectLocationProjectDataProfile(string projectId, string locationId, string projectDataProfileId)

Formats the IDs into the string representation of this ProjectDataProfileName with pattern projects/{project}/locations/{location}/projectDataProfiles/{project_data_profile}.

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

Returns
Type	Description
`string`	The string representation of this ProjectDataProfileName with pattern `projects/{project}/locations/{location}/projectDataProfiles/{project_data_profile}`.

FromOrganizationLocationProjectDataProfile(string, string, string)

public static ProjectDataProfileName FromOrganizationLocationProjectDataProfile(string organizationId, string locationId, string projectDataProfileId)

Creates a ProjectDataProfileName with the pattern organizations/{organization}/locations/{location}/projectDataProfiles/{project_data_profile}.

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

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

FromProjectLocationProjectDataProfile(string, string, string)

public static ProjectDataProfileName FromProjectLocationProjectDataProfile(string projectId, string locationId, string projectDataProfileId)

Creates a ProjectDataProfileName with the pattern projects/{project}/locations/{location}/projectDataProfiles/{project_data_profile}.

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

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

FromUnparsed(UnparsedResourceName)

public static ProjectDataProfileName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ProjectDataProfileName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

organizations/{organization}/locations/{location}/projectDataProfiles/{project_data_profile}
projects/{project}/locations/{location}/projectDataProfiles/{project_data_profile}

Parse(string, bool)

public static ProjectDataProfileName Parse(string projectDataProfileName, bool allowUnparsed)

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

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

Remarks

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

organizations/{organization}/locations/{location}/projectDataProfiles/{project_data_profile}
projects/{project}/locations/{location}/projectDataProfiles/{project_data_profile}

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

public static bool TryParse(string projectDataProfileName, out ProjectDataProfileName result)

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

Parameters
Name	Description
`projectDataProfileName`	`string` The resource name in string form. Must not be `null`.
`result`	`ProjectDataProfileName` When this method returns, the parsed ProjectDataProfileName, 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}/locations/{location}/projectDataProfiles/{project_data_profile}
projects/{project}/locations/{location}/projectDataProfiles/{project_data_profile}

TryParse(string, bool, out ProjectDataProfileName)

public static bool TryParse(string projectDataProfileName, bool allowUnparsed, out ProjectDataProfileName result)

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

Parameters
Name	Description
`projectDataProfileName`	`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`	`ProjectDataProfileName` When this method returns, the parsed ProjectDataProfileName, 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}/locations/{location}/projectDataProfiles/{project_data_profile}
projects/{project}/locations/{location}/projectDataProfiles/{project_data_profile}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ProjectDataProfileName, ProjectDataProfileName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`ProjectDataProfileName` The first resource name to compare, or null.
`b`	`ProjectDataProfileName` 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 !=(ProjectDataProfileName, ProjectDataProfileName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`ProjectDataProfileName` The first resource name to compare, or null.
`b`	`ProjectDataProfileName` 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.