Cloud Dataplex v1 API - Class EncryptionConfigName (3.8.0) 

public sealed class EncryptionConfigName : IResourceName, IEquatable<EncryptionConfigName>

Reference documentation and code samples for the Cloud Dataplex v1 API class EncryptionConfigName.

Resource name for the EncryptionConfig resource.

Inheritance

object > EncryptionConfigName

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

EncryptionConfigName(string, string, string)

public EncryptionConfigName(string organizationId, string locationId, string encryptionConfigId)

Constructs a new instance of a EncryptionConfigName class from the component parts of pattern organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config}

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.
encryptionConfigId string

The EncryptionConfig ID. Must not be null or empty.

Properties

EncryptionConfigId

public string EncryptionConfigId { get; }

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

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. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

OrganizationId

public string OrganizationId { get; }

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

Property Value
Type Description
string

Type

public EncryptionConfigName.ResourceNameType Type { get; }

The EncryptionConfigName.ResourceNameType of the contained resource name.

Property Value
Type Description
EncryptionConfigNameResourceNameType

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

Formats the IDs into the string representation of this EncryptionConfigName with pattern organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config}.

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.
encryptionConfigId string

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

The string representation of this EncryptionConfigName with pattern organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config}.

FormatOrganizationLocationEncryptionConfig(string, string, string)

public static string FormatOrganizationLocationEncryptionConfig(string organizationId, string locationId, string encryptionConfigId)

Formats the IDs into the string representation of this EncryptionConfigName with pattern organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config}.

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.
encryptionConfigId string

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

The string representation of this EncryptionConfigName with pattern organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config}.

FromOrganizationLocationEncryptionConfig(string, string, string)

public static EncryptionConfigName FromOrganizationLocationEncryptionConfig(string organizationId, string locationId, string encryptionConfigId)

Creates a EncryptionConfigName with the pattern organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config}.

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.
encryptionConfigId string

The EncryptionConfig ID. Must not be null or empty.
Returns
Type Description
EncryptionConfigName

A new instance of EncryptionConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static EncryptionConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EncryptionConfigName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of EncryptionConfigName 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 EncryptionConfigName Parse(string encryptionConfigName)

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

Parameter
Name Description
encryptionConfigName string

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

The parsed EncryptionConfigName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config}

Parse(string, bool)

public static EncryptionConfigName Parse(string encryptionConfigName, bool allowUnparsed)

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

Parameters
Name Description
encryptionConfigName 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
EncryptionConfigName

The parsed EncryptionConfigName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config}
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 EncryptionConfigName)

public static bool TryParse(string encryptionConfigName, out EncryptionConfigName result)

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

Parameters
Name Description
encryptionConfigName string

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

When this method returns, the parsed EncryptionConfigName, 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}/encryptionConfigs/{encryption_config}

TryParse(string, bool, out EncryptionConfigName)

public static bool TryParse(string encryptionConfigName, bool allowUnparsed, out EncryptionConfigName result)

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

Parameters
Name Description
encryptionConfigName 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 EncryptionConfigName

When this method returns, the parsed EncryptionConfigName, 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}/encryptionConfigs/{encryption_config}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(EncryptionConfigName, EncryptionConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a EncryptionConfigName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a EncryptionConfigName

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

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.