Google Cloud Data Loss Prevention v2 API - Class TableDataProfileName (4.21.0) 

public sealed class TableDataProfileName : IResourceName, IEquatable<TableDataProfileName>

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

Resource name for the TableDataProfile resource.

Inheritance

object > TableDataProfileName

Namespace

Google.Cloud.Dlp.V2

Assembly

Google.Cloud.Dlp.V2.dll

Constructors

TableDataProfileName(string, string, string)

public TableDataProfileName(string organizationId, string locationId, string tableDataProfileId)

Constructs a new instance of a TableDataProfileName class from the component parts of pattern organizations/{organization}/locations/{location}/tableDataProfiles/{table_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.
tableDataProfileId string

The TableDataProfile 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

TableDataProfileId

public string TableDataProfileId { get; }

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

Property Value
Type Description
string

Type

public TableDataProfileName.ResourceNameType Type { get; }

The TableDataProfileName.ResourceNameType of the contained resource name.

Property Value
Type Description
TableDataProfileNameResourceNameType

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

Formats the IDs into the string representation of this TableDataProfileName with pattern organizations/{organization}/locations/{location}/tableDataProfiles/{table_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.
tableDataProfileId string

The TableDataProfile ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this TableDataProfileName with pattern organizations/{organization}/locations/{location}/tableDataProfiles/{table_data_profile}.

FormatOrganizationLocationTableDataProfile(string, string, string)

public static string FormatOrganizationLocationTableDataProfile(string organizationId, string locationId, string tableDataProfileId)

Formats the IDs into the string representation of this TableDataProfileName with pattern organizations/{organization}/locations/{location}/tableDataProfiles/{table_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.
tableDataProfileId string

The TableDataProfile ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this TableDataProfileName with pattern organizations/{organization}/locations/{location}/tableDataProfiles/{table_data_profile}.

FormatProjectLocationTableDataProfile(string, string, string)

public static string FormatProjectLocationTableDataProfile(string projectId, string locationId, string tableDataProfileId)

Formats the IDs into the string representation of this TableDataProfileName with pattern projects/{project}/locations/{location}/tableDataProfiles/{table_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.
tableDataProfileId string

The TableDataProfile ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this TableDataProfileName with pattern projects/{project}/locations/{location}/tableDataProfiles/{table_data_profile}.

FromOrganizationLocationTableDataProfile(string, string, string)

public static TableDataProfileName FromOrganizationLocationTableDataProfile(string organizationId, string locationId, string tableDataProfileId)

Creates a TableDataProfileName with the pattern organizations/{organization}/locations/{location}/tableDataProfiles/{table_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.
tableDataProfileId string

The TableDataProfile ID. Must not be null or empty.
Returns
Type Description
TableDataProfileName

A new instance of TableDataProfileName constructed from the provided ids.

FromProjectLocationTableDataProfile(string, string, string)

public static TableDataProfileName FromProjectLocationTableDataProfile(string projectId, string locationId, string tableDataProfileId)

Creates a TableDataProfileName with the pattern projects/{project}/locations/{location}/tableDataProfiles/{table_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.
tableDataProfileId string

The TableDataProfile ID. Must not be null or empty.
Returns
Type Description
TableDataProfileName

A new instance of TableDataProfileName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TableDataProfileName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TableDataProfileName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
TableDataProfileName

A new instance of TableDataProfileName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static TableDataProfileName Parse(string tableDataProfileName)

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

Parameter
Name Description
tableDataProfileName string

The resource name in string form. Must not be null.
Returns
Type Description
TableDataProfileName

The parsed TableDataProfileName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/tableDataProfiles/{table_data_profile}
  • projects/{project}/locations/{location}/tableDataProfiles/{table_data_profile}

Parse(string, bool)

public static TableDataProfileName Parse(string tableDataProfileName, bool allowUnparsed)

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

Parameters
Name Description
tableDataProfileName 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
TableDataProfileName

The parsed TableDataProfileName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/tableDataProfiles/{table_data_profile}
  • projects/{project}/locations/{location}/tableDataProfiles/{table_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

TryParse(string, out TableDataProfileName)

public static bool TryParse(string tableDataProfileName, out TableDataProfileName result)

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

Parameters
Name Description
tableDataProfileName string

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

When this method returns, the parsed TableDataProfileName, 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}/tableDataProfiles/{table_data_profile}
  • projects/{project}/locations/{location}/tableDataProfiles/{table_data_profile}

TryParse(string, bool, out TableDataProfileName)

public static bool TryParse(string tableDataProfileName, bool allowUnparsed, out TableDataProfileName result)

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

Parameters
Name Description
tableDataProfileName 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 TableDataProfileName

When this method returns, the parsed TableDataProfileName, 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}/tableDataProfiles/{table_data_profile}
  • projects/{project}/locations/{location}/tableDataProfiles/{table_data_profile}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(TableDataProfileName, TableDataProfileName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a TableDataProfileName

The first resource name to compare, or null.
b TableDataProfileName

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 !=(TableDataProfileName, TableDataProfileName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a TableDataProfileName

The first resource name to compare, or null.
b TableDataProfileName

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.