Developer Connect v1 API - Class InsightsConfigName (1.0.0-beta02) 

public sealed class InsightsConfigName : IResourceName, IEquatable<InsightsConfigName>

Reference documentation and code samples for the Developer Connect v1 API class InsightsConfigName.

Resource name for the InsightsConfig resource.

Inheritance

object > InsightsConfigName

Namespace

Google.Cloud.DeveloperConnect.V1

Assembly

Google.Cloud.DeveloperConnect.V1.dll

Constructors

InsightsConfigName(string, string, string)

public InsightsConfigName(string projectId, string locationId, string insightsConfigId)

Constructs a new instance of a InsightsConfigName class from the component parts of pattern projects/{project}/locations/{location}/insightsConfigs/{insights_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.
insightsConfigId string

The InsightsConfig ID. Must not be null or empty.

Properties

InsightsConfigId

public string InsightsConfigId { get; }

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

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

The InsightsConfigName.ResourceNameType of the contained resource name.

Property Value
Type Description
InsightsConfigNameResourceNameType

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

Formats the IDs into the string representation of this InsightsConfigName with pattern projects/{project}/locations/{location}/insightsConfigs/{insights_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.
insightsConfigId string

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

The string representation of this InsightsConfigName with pattern projects/{project}/locations/{location}/insightsConfigs/{insights_config}.

FormatProjectLocationInsightsConfig(string, string, string)

public static string FormatProjectLocationInsightsConfig(string projectId, string locationId, string insightsConfigId)

Formats the IDs into the string representation of this InsightsConfigName with pattern projects/{project}/locations/{location}/insightsConfigs/{insights_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.
insightsConfigId string

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

The string representation of this InsightsConfigName with pattern projects/{project}/locations/{location}/insightsConfigs/{insights_config}.

FromProjectLocationInsightsConfig(string, string, string)

public static InsightsConfigName FromProjectLocationInsightsConfig(string projectId, string locationId, string insightsConfigId)

Creates a InsightsConfigName with the pattern projects/{project}/locations/{location}/insightsConfigs/{insights_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.
insightsConfigId string

The InsightsConfig ID. Must not be null or empty.
Returns
Type Description
InsightsConfigName

A new instance of InsightsConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static InsightsConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a InsightsConfigName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
insightsConfigName string

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

The parsed InsightsConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/insightsConfigs/{insights_config}

Parse(string, bool)

public static InsightsConfigName Parse(string insightsConfigName, bool allowUnparsed)

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

Parameters
Name Description
insightsConfigName 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
InsightsConfigName

The parsed InsightsConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/insightsConfigs/{insights_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 InsightsConfigName)

public static bool TryParse(string insightsConfigName, out InsightsConfigName result)

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

Parameters
Name Description
insightsConfigName string

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

When this method returns, the parsed InsightsConfigName, 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}/insightsConfigs/{insights_config}

TryParse(string, bool, out InsightsConfigName)

public static bool TryParse(string insightsConfigName, bool allowUnparsed, out InsightsConfigName result)

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

Parameters
Name Description
insightsConfigName 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 InsightsConfigName

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

Operators

operator ==(InsightsConfigName, InsightsConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a InsightsConfigName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a InsightsConfigName

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

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.