Discovery Engine v1 API - Class CmekConfigName (1.8.0) 

public sealed class CmekConfigName : IResourceName, IEquatable<CmekConfigName>

Reference documentation and code samples for the Discovery Engine v1 API class CmekConfigName.

Resource name for the CmekConfig resource.

Inheritance

object > CmekConfigName

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

CmekConfigName(string, string)

public CmekConfigName(string projectId, string locationId)

Constructs a new instance of a CmekConfigName class from the component parts of pattern projects/{project}/locations/{location}/cmekConfig

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.

Properties

CmekConfigId

public string CmekConfigId { get; }

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

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 CmekConfigName.ResourceNameType Type { get; }

The CmekConfigName.ResourceNameType of the contained resource name.

Property Value
Type Description
CmekConfigNameResourceNameType

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)

public static string Format(string projectId, string locationId)

Formats the IDs into the string representation of this CmekConfigName with pattern projects/{project}/locations/{location}/cmekConfig.

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.
Returns
Type Description
string

The string representation of this CmekConfigName with pattern projects/{project}/locations/{location}/cmekConfig.

FormatProjectLocation(string, string)

public static string FormatProjectLocation(string projectId, string locationId)

Formats the IDs into the string representation of this CmekConfigName with pattern projects/{project}/locations/{location}/cmekConfig.

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.
Returns
Type Description
string

The string representation of this CmekConfigName with pattern projects/{project}/locations/{location}/cmekConfig.

FormatProjectLocationCmekConfig(string, string, string)

public static string FormatProjectLocationCmekConfig(string projectId, string locationId, string cmekConfigId)

Formats the IDs into the string representation of this CmekConfigName with pattern projects/{project}/locations/{location}/cmekConfigs/{cmek_config}.

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

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

The string representation of this CmekConfigName with pattern projects/{project}/locations/{location}/cmekConfigs/{cmek_config}.

FromProjectLocation(string, string)

public static CmekConfigName FromProjectLocation(string projectId, string locationId)

Creates a CmekConfigName with the pattern projects/{project}/locations/{location}/cmekConfig.

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.
Returns
Type Description
CmekConfigName

A new instance of CmekConfigName constructed from the provided ids.

FromProjectLocationCmekConfig(string, string, string)

public static CmekConfigName FromProjectLocationCmekConfig(string projectId, string locationId, string cmekConfigId)

Creates a CmekConfigName with the pattern projects/{project}/locations/{location}/cmekConfigs/{cmek_config}.

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

The CmekConfig ID. Must not be null or empty.
Returns
Type Description
CmekConfigName

A new instance of CmekConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CmekConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CmekConfigName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
cmekConfigName string

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

The parsed CmekConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/cmekConfig
  • projects/{project}/locations/{location}/cmekConfigs/{cmek_config}

Parse(string, bool)

public static CmekConfigName Parse(string cmekConfigName, bool allowUnparsed)

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

Parameters
Name Description
cmekConfigName 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
CmekConfigName

The parsed CmekConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/cmekConfig
  • projects/{project}/locations/{location}/cmekConfigs/{cmek_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 CmekConfigName)

public static bool TryParse(string cmekConfigName, out CmekConfigName result)

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

Parameters
Name Description
cmekConfigName string

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

When this method returns, the parsed CmekConfigName, 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:

  • projects/{project}/locations/{location}/cmekConfig
  • projects/{project}/locations/{location}/cmekConfigs/{cmek_config}

TryParse(string, bool, out CmekConfigName)

public static bool TryParse(string cmekConfigName, bool allowUnparsed, out CmekConfigName result)

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

Parameters
Name Description
cmekConfigName 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 CmekConfigName

When this method returns, the parsed CmekConfigName, 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:

  • projects/{project}/locations/{location}/cmekConfig
  • projects/{project}/locations/{location}/cmekConfigs/{cmek_config}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(CmekConfigName, CmekConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a CmekConfigName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a CmekConfigName

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

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.