Financial Services v1 API - Class EngineConfigName (1.0.0-beta01) 

public sealed class EngineConfigName : IResourceName, IEquatable<EngineConfigName>

Reference documentation and code samples for the Financial Services v1 API class EngineConfigName.

Resource name for the EngineConfig resource.

Inheritance

object > EngineConfigName

Namespace

Google.Cloud.FinancialServices.V1

Assembly

Google.Cloud.FinancialServices.V1.dll

Constructors

EngineConfigName(string, string, string, string)

public EngineConfigName(string projectNumId, string locationId, string instanceId, string engineConfigId)

Constructs a new instance of a EngineConfigName class from the component parts of pattern projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}

Parameters
Name Description
projectNumId string

The ProjectNum ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
instanceId string

The Instance ID. Must not be null or empty.
engineConfigId string

The EngineConfig ID. Must not be null or empty.

Properties

EngineConfigId

public string EngineConfigId { get; }

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

Property Value
Type Description
string

InstanceId

public string InstanceId { get; }

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

ProjectNumId

public string ProjectNumId { get; }

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

Property Value
Type Description
string

Type

public EngineConfigName.ResourceNameType Type { get; }

The EngineConfigName.ResourceNameType of the contained resource name.

Property Value
Type Description
EngineConfigNameResourceNameType

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, string)

public static string Format(string projectNumId, string locationId, string instanceId, string engineConfigId)

Formats the IDs into the string representation of this EngineConfigName with pattern projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}.

Parameters
Name Description
projectNumId string

The ProjectNum ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
instanceId string

The Instance ID. Must not be null or empty.
engineConfigId string

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

The string representation of this EngineConfigName with pattern projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}.

FormatProjectNumLocationInstanceEngineConfig(string, string, string, string)

public static string FormatProjectNumLocationInstanceEngineConfig(string projectNumId, string locationId, string instanceId, string engineConfigId)

Formats the IDs into the string representation of this EngineConfigName with pattern projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}.

Parameters
Name Description
projectNumId string

The ProjectNum ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
instanceId string

The Instance ID. Must not be null or empty.
engineConfigId string

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

The string representation of this EngineConfigName with pattern projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}.

FromProjectNumLocationInstanceEngineConfig(string, string, string, string)

public static EngineConfigName FromProjectNumLocationInstanceEngineConfig(string projectNumId, string locationId, string instanceId, string engineConfigId)

Creates a EngineConfigName with the pattern projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}.

Parameters
Name Description
projectNumId string

The ProjectNum ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
instanceId string

The Instance ID. Must not be null or empty.
engineConfigId string

The EngineConfig ID. Must not be null or empty.
Returns
Type Description
EngineConfigName

A new instance of EngineConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static EngineConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EngineConfigName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
engineConfigName string

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

The parsed EngineConfigName if successful.
Remarks

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

  • projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}

Parse(string, bool)

public static EngineConfigName Parse(string engineConfigName, bool allowUnparsed)

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

Parameters
Name Description
engineConfigName 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
EngineConfigName

The parsed EngineConfigName if successful.
Remarks

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

  • projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_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 EngineConfigName)

public static bool TryParse(string engineConfigName, out EngineConfigName result)

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

Parameters
Name Description
engineConfigName string

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

When this method returns, the parsed EngineConfigName, 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_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}

TryParse(string, bool, out EngineConfigName)

public static bool TryParse(string engineConfigName, bool allowUnparsed, out EngineConfigName result)

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

Parameters
Name Description
engineConfigName 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 EngineConfigName

When this method returns, the parsed EngineConfigName, 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_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(EngineConfigName, EngineConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a EngineConfigName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a EngineConfigName

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

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.