Oracle Database@Google Cloud v1 API - Class GoldengateConnectionName (1.6.0) 

public sealed class GoldengateConnectionName : IResourceName, IEquatable<GoldengateConnectionName>

Reference documentation and code samples for the Oracle Database@Google Cloud v1 API class GoldengateConnectionName.

Resource name for the GoldengateConnection resource.

Inheritance

object > GoldengateConnectionName

Namespace

Google.Cloud.OracleDatabase.V1

Assembly

Google.Cloud.OracleDatabase.V1.dll

Constructors

GoldengateConnectionName(string, string, string)

public GoldengateConnectionName(string projectId, string locationId, string goldengateConnectionId)

Constructs a new instance of a GoldengateConnectionName class from the component parts of pattern projects/{project}/locations/{location}/goldengateConnections/{goldengate_connection}

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

The GoldengateConnection ID. Must not be null or empty.

Properties

GoldengateConnectionId

public string GoldengateConnectionId { get; }

The GoldengateConnection 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 GoldengateConnectionName.ResourceNameType Type { get; }

The GoldengateConnectionName.ResourceNameType of the contained resource name.

Property Value
Type Description
GoldengateConnectionNameResourceNameType

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

Formats the IDs into the string representation of this GoldengateConnectionName with pattern projects/{project}/locations/{location}/goldengateConnections/{goldengate_connection}.

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

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

The string representation of this GoldengateConnectionName with pattern projects/{project}/locations/{location}/goldengateConnections/{goldengate_connection}.

FormatProjectLocationGoldengateConnection(string, string, string)

public static string FormatProjectLocationGoldengateConnection(string projectId, string locationId, string goldengateConnectionId)

Formats the IDs into the string representation of this GoldengateConnectionName with pattern projects/{project}/locations/{location}/goldengateConnections/{goldengate_connection}.

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

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

The string representation of this GoldengateConnectionName with pattern projects/{project}/locations/{location}/goldengateConnections/{goldengate_connection}.

FromProjectLocationGoldengateConnection(string, string, string)

public static GoldengateConnectionName FromProjectLocationGoldengateConnection(string projectId, string locationId, string goldengateConnectionId)

Creates a GoldengateConnectionName with the pattern projects/{project}/locations/{location}/goldengateConnections/{goldengate_connection}.

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

The GoldengateConnection ID. Must not be null or empty.
Returns
Type Description
GoldengateConnectionName

A new instance of GoldengateConnectionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static GoldengateConnectionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GoldengateConnectionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
goldengateConnectionName string

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

The parsed GoldengateConnectionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/goldengateConnections/{goldengate_connection}

Parse(string, bool)

public static GoldengateConnectionName Parse(string goldengateConnectionName, bool allowUnparsed)

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

Parameters
Name Description
goldengateConnectionName 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
GoldengateConnectionName

The parsed GoldengateConnectionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/goldengateConnections/{goldengate_connection}

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

public static bool TryParse(string goldengateConnectionName, out GoldengateConnectionName result)

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

Parameters
Name Description
goldengateConnectionName string

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

When this method returns, the parsed GoldengateConnectionName, 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}/goldengateConnections/{goldengate_connection}

TryParse(string, bool, out GoldengateConnectionName)

public static bool TryParse(string goldengateConnectionName, bool allowUnparsed, out GoldengateConnectionName result)

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

Parameters
Name Description
goldengateConnectionName 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 GoldengateConnectionName

When this method returns, the parsed GoldengateConnectionName, 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}/goldengateConnections/{goldengate_connection}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(GoldengateConnectionName, GoldengateConnectionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a GoldengateConnectionName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a GoldengateConnectionName

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

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.