Google Cloud Data Loss Prevention v2 API - Class DiscoveryConfigName (2.15.0)

public sealed class DiscoveryConfigName : IResourceName, IEquatable<DiscoveryConfigName>

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

Resource name for the DiscoveryConfig resource.

Inheritance

object > DiscoveryConfigName

Namespace

Google.Cloud.Dlp.V2

Assembly

Google.Cloud.Dlp.V2.dll

Constructors

DiscoveryConfigName(string, string, string)

public DiscoveryConfigName(string projectId, string locationId, string discoveryConfigId)

Constructs a new instance of a DiscoveryConfigName class from the component parts of pattern projects/{project}/locations/{location}/discoveryConfigs/{discovery_config}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

discoveryConfigIdstring

The DiscoveryConfig ID. Must not be null or empty.

Properties

DiscoveryConfigId

public string DiscoveryConfigId { get; }

The DiscoveryConfig ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
bool

LocationId

public string LocationId { get; }

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

Type

public DiscoveryConfigName.ResourceNameType Type { get; }

The DiscoveryConfigName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
DiscoveryConfigNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string, string)

public static string Format(string projectId, string locationId, string discoveryConfigId)

Formats the IDs into the string representation of this DiscoveryConfigName with pattern projects/{project}/locations/{location}/discoveryConfigs/{discovery_config}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

discoveryConfigIdstring

The DiscoveryConfig ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this DiscoveryConfigName with pattern projects/{project}/locations/{location}/discoveryConfigs/{discovery_config}.

FormatProjectLocationDiscoveryConfig(string, string, string)

public static string FormatProjectLocationDiscoveryConfig(string projectId, string locationId, string discoveryConfigId)

Formats the IDs into the string representation of this DiscoveryConfigName with pattern projects/{project}/locations/{location}/discoveryConfigs/{discovery_config}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

discoveryConfigIdstring

The DiscoveryConfig ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this DiscoveryConfigName with pattern projects/{project}/locations/{location}/discoveryConfigs/{discovery_config}.

FromProjectLocationDiscoveryConfig(string, string, string)

public static DiscoveryConfigName FromProjectLocationDiscoveryConfig(string projectId, string locationId, string discoveryConfigId)

Creates a DiscoveryConfigName with the pattern projects/{project}/locations/{location}/discoveryConfigs/{discovery_config}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

discoveryConfigIdstring

The DiscoveryConfig ID. Must not be null or empty.

Returns
TypeDescription
DiscoveryConfigName

A new instance of DiscoveryConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DiscoveryConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DiscoveryConfigName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
DiscoveryConfigName

A new instance of DiscoveryConfigName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static DiscoveryConfigName Parse(string discoveryConfigName)

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

Parameter
NameDescription
discoveryConfigNamestring

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

Returns
TypeDescription
DiscoveryConfigName

The parsed DiscoveryConfigName if successful.

Remarks

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

  • projects/{project}/locations/{location}/discoveryConfigs/{discovery_config}

Parse(string, bool)

public static DiscoveryConfigName Parse(string discoveryConfigName, bool allowUnparsed)

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

Parameters
NameDescription
discoveryConfigNamestring

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

allowUnparsedbool

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
TypeDescription
DiscoveryConfigName

The parsed DiscoveryConfigName if successful.

Remarks

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

  • projects/{project}/locations/{location}/discoveryConfigs/{discovery_config}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
string

The string representation of the resource name.

Overrides

TryParse(string, out DiscoveryConfigName)

public static bool TryParse(string discoveryConfigName, out DiscoveryConfigName result)

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

Parameters
NameDescription
discoveryConfigNamestring

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

resultDiscoveryConfigName

When this method returns, the parsed DiscoveryConfigName, or null if parsing failed.

Returns
TypeDescription
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:

  • projects/{project}/locations/{location}/discoveryConfigs/{discovery_config}

TryParse(string, bool, out DiscoveryConfigName)

public static bool TryParse(string discoveryConfigName, bool allowUnparsed, out DiscoveryConfigName result)

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

Parameters
NameDescription
discoveryConfigNamestring

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

allowUnparsedbool

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.

resultDiscoveryConfigName

When this method returns, the parsed DiscoveryConfigName, or null if parsing failed.

Returns
TypeDescription
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:

  • projects/{project}/locations/{location}/discoveryConfigs/{discovery_config}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(DiscoveryConfigName, DiscoveryConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aDiscoveryConfigName

The first resource name to compare, or null.

bDiscoveryConfigName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(DiscoveryConfigName, DiscoveryConfigName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aDiscoveryConfigName

The first resource name to compare, or null.

bDiscoveryConfigName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.