Discovery Engine v1 API - Class LicenseConfigName (1.8.0) 

public sealed class LicenseConfigName : IResourceName, IEquatable<LicenseConfigName>

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

Resource name for the LicenseConfig resource.

Inheritance

object > LicenseConfigName

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

LicenseConfigName(string, string, string)

public LicenseConfigName(string projectId, string locationId, string licenseConfigId)

Constructs a new instance of a LicenseConfigName class from the component parts of pattern projects/{project}/locations/{location}/licenseConfigs/{license_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.
licenseConfigId string

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

LicenseConfigId

public string LicenseConfigId { get; }

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

Property Value
Type Description
string

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

ProjectId

public string ProjectId { get; }

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

Property Value
Type Description
string

Type

public LicenseConfigName.ResourceNameType Type { get; }

The LicenseConfigName.ResourceNameType of the contained resource name.

Property Value
Type Description
LicenseConfigNameResourceNameType

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 projectId, string locationId, string licenseConfigId)

Formats the IDs into the string representation of this LicenseConfigName with pattern projects/{project}/locations/{location}/licenseConfigs/{license_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.
licenseConfigId string

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

The string representation of this LicenseConfigName with pattern projects/{project}/locations/{location}/licenseConfigs/{license_config}.

FormatProjectLocationLicenseConfig(string, string, string)

public static string FormatProjectLocationLicenseConfig(string projectId, string locationId, string licenseConfigId)

Formats the IDs into the string representation of this LicenseConfigName with pattern projects/{project}/locations/{location}/licenseConfigs/{license_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.
licenseConfigId string

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

The string representation of this LicenseConfigName with pattern projects/{project}/locations/{location}/licenseConfigs/{license_config}.

FromProjectLocationLicenseConfig(string, string, string)

public static LicenseConfigName FromProjectLocationLicenseConfig(string projectId, string locationId, string licenseConfigId)

Creates a LicenseConfigName with the pattern projects/{project}/locations/{location}/licenseConfigs/{license_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.
licenseConfigId string

The LicenseConfig ID. Must not be null or empty.
Returns
Type Description
LicenseConfigName

A new instance of LicenseConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static LicenseConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a LicenseConfigName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
licenseConfigName string

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

The parsed LicenseConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/licenseConfigs/{license_config}

Parse(string, bool)

public static LicenseConfigName Parse(string licenseConfigName, bool allowUnparsed)

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

Parameters
Name Description
licenseConfigName 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
LicenseConfigName

The parsed LicenseConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/licenseConfigs/{license_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 LicenseConfigName)

public static bool TryParse(string licenseConfigName, out LicenseConfigName result)

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

Parameters
Name Description
licenseConfigName string

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

When this method returns, the parsed LicenseConfigName, 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}/licenseConfigs/{license_config}

TryParse(string, bool, out LicenseConfigName)

public static bool TryParse(string licenseConfigName, bool allowUnparsed, out LicenseConfigName result)

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

Parameters
Name Description
licenseConfigName 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 LicenseConfigName

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

Operators

operator ==(LicenseConfigName, LicenseConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a LicenseConfigName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a LicenseConfigName

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

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.