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

public sealed class FileStoreDataProfileName : IResourceName, IEquatable<FileStoreDataProfileName>

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

Resource name for the FileStoreDataProfile resource.

Inheritance

object > FileStoreDataProfileName

Implements

IResourceName, IEquatable FileStoreDataProfileName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dlp.V2

Assembly

Google.Cloud.Dlp.V2.dll

Constructors

FileStoreDataProfileName(string, string, string)

public FileStoreDataProfileName(string organizationId, string locationId, string fileStoreDataProfileId)

Constructs a new instance of a FileStoreDataProfileName class from the component parts of pattern organizations/{organization}/locations/{location}/fileStoreDataProfiles/{file_store_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.
`fileStoreDataProfileId`	`string` The `FileStoreDataProfile` ID. Must not be `null` or empty.

Properties

FileStoreDataProfileId

public string FileStoreDataProfileId { get; }

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

The FileStoreDataProfileName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`FileStoreDataProfileNameResourceNameType`

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

Formats the IDs into the string representation of this FileStoreDataProfileName with pattern organizations/{organization}/locations/{location}/fileStoreDataProfiles/{file_store_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.
`fileStoreDataProfileId`	`string` The `FileStoreDataProfile` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this FileStoreDataProfileName with pattern `organizations/{organization}/locations/{location}/fileStoreDataProfiles/{file_store_data_profile}`.

FormatOrganizationLocationFileStoreDataProfile(string, string, string)

public static string FormatOrganizationLocationFileStoreDataProfile(string organizationId, string locationId, string fileStoreDataProfileId)

Formats the IDs into the string representation of this FileStoreDataProfileName with pattern organizations/{organization}/locations/{location}/fileStoreDataProfiles/{file_store_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.
`fileStoreDataProfileId`	`string` The `FileStoreDataProfile` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this FileStoreDataProfileName with pattern `organizations/{organization}/locations/{location}/fileStoreDataProfiles/{file_store_data_profile}`.

FormatProjectLocationFileStoreDataProfile(string, string, string)

public static string FormatProjectLocationFileStoreDataProfile(string projectId, string locationId, string fileStoreDataProfileId)

Formats the IDs into the string representation of this FileStoreDataProfileName with pattern projects/{project}/locations/{location}/fileStoreDataProfiles/{file_store_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.
`fileStoreDataProfileId`	`string` The `FileStoreDataProfile` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this FileStoreDataProfileName with pattern `projects/{project}/locations/{location}/fileStoreDataProfiles/{file_store_data_profile}`.

FromOrganizationLocationFileStoreDataProfile(string, string, string)

public static FileStoreDataProfileName FromOrganizationLocationFileStoreDataProfile(string organizationId, string locationId, string fileStoreDataProfileId)

Creates a FileStoreDataProfileName with the pattern organizations/{organization}/locations/{location}/fileStoreDataProfiles/{file_store_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.
`fileStoreDataProfileId`	`string` The `FileStoreDataProfile` ID. Must not be `null` or empty.

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

FromProjectLocationFileStoreDataProfile(string, string, string)

public static FileStoreDataProfileName FromProjectLocationFileStoreDataProfile(string projectId, string locationId, string fileStoreDataProfileId)

Creates a FileStoreDataProfileName with the pattern projects/{project}/locations/{location}/fileStoreDataProfiles/{file_store_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.
`fileStoreDataProfileId`	`string` The `FileStoreDataProfile` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static FileStoreDataProfileName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FileStoreDataProfileName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

organizations/{organization}/locations/{location}/fileStoreDataProfiles/{file_store_data_profile}
projects/{project}/locations/{location}/fileStoreDataProfiles/{file_store_data_profile}

Parse(string, bool)

public static FileStoreDataProfileName Parse(string fileStoreDataProfileName, bool allowUnparsed)

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

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

Remarks

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

organizations/{organization}/locations/{location}/fileStoreDataProfiles/{file_store_data_profile}
projects/{project}/locations/{location}/fileStoreDataProfiles/{file_store_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 FileStoreDataProfileName)

public static bool TryParse(string fileStoreDataProfileName, out FileStoreDataProfileName result)

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

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

TryParse(string, bool, out FileStoreDataProfileName)

public static bool TryParse(string fileStoreDataProfileName, bool allowUnparsed, out FileStoreDataProfileName result)

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

Parameters
Name	Description
`fileStoreDataProfileName`	`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`	`FileStoreDataProfileName` When this method returns, the parsed FileStoreDataProfileName, 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}/fileStoreDataProfiles/{file_store_data_profile}
projects/{project}/locations/{location}/fileStoreDataProfiles/{file_store_data_profile}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(FileStoreDataProfileName, FileStoreDataProfileName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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