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

public sealed class GoldengateDeploymentName : IResourceName, IEquatable<GoldengateDeploymentName>

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

Resource name for the GoldengateDeployment resource.

Inheritance

object > GoldengateDeploymentName

Namespace

Google.Cloud.OracleDatabase.V1

Assembly

Google.Cloud.OracleDatabase.V1.dll

Constructors

GoldengateDeploymentName(string, string, string)

public GoldengateDeploymentName(string projectId, string locationId, string goldengateDeploymentId)

Constructs a new instance of a GoldengateDeploymentName class from the component parts of pattern projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}

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.

goldengateDeploymentId string

The GoldengateDeployment ID. Must not be null or empty.

Properties

GoldengateDeploymentId

public string GoldengateDeploymentId { get; }

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

The GoldengateDeploymentName.ResourceNameType of the contained resource name.

Property Value
Type Description
GoldengateDeploymentNameResourceNameType

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

Formats the IDs into the string representation of this GoldengateDeploymentName with pattern projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}.

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.

goldengateDeploymentId string

The GoldengateDeployment ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this GoldengateDeploymentName with pattern projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}.

FormatProjectLocationGoldengateDeployment(string, string, string)

public static string FormatProjectLocationGoldengateDeployment(string projectId, string locationId, string goldengateDeploymentId)

Formats the IDs into the string representation of this GoldengateDeploymentName with pattern projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}.

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.

goldengateDeploymentId string

The GoldengateDeployment ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this GoldengateDeploymentName with pattern projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}.

FromProjectLocationGoldengateDeployment(string, string, string)

public static GoldengateDeploymentName FromProjectLocationGoldengateDeployment(string projectId, string locationId, string goldengateDeploymentId)

Creates a GoldengateDeploymentName with the pattern projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}.

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.

goldengateDeploymentId string

The GoldengateDeployment ID. Must not be null or empty.

Returns
Type Description
GoldengateDeploymentName

A new instance of GoldengateDeploymentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static GoldengateDeploymentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GoldengateDeploymentName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
GoldengateDeploymentName

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

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

Parameter
Name Description
goldengateDeploymentName string

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

Returns
Type Description
GoldengateDeploymentName

The parsed GoldengateDeploymentName if successful.

Remarks

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

  • projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}

Parse(string, bool)

public static GoldengateDeploymentName Parse(string goldengateDeploymentName, bool allowUnparsed)

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

Parameters
Name Description
goldengateDeploymentName 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
GoldengateDeploymentName

The parsed GoldengateDeploymentName if successful.

Remarks

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

  • projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}

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

public static bool TryParse(string goldengateDeploymentName, out GoldengateDeploymentName result)

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

Parameters
Name Description
goldengateDeploymentName string

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

result GoldengateDeploymentName

When this method returns, the parsed GoldengateDeploymentName, 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}/goldengateDeployments/{goldengate_deployment}

TryParse(string, bool, out GoldengateDeploymentName)

public static bool TryParse(string goldengateDeploymentName, bool allowUnparsed, out GoldengateDeploymentName result)

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

Parameters
Name Description
goldengateDeploymentName 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 GoldengateDeploymentName

When this method returns, the parsed GoldengateDeploymentName, 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}/goldengateDeployments/{goldengate_deployment}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(GoldengateDeploymentName, GoldengateDeploymentName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a GoldengateDeploymentName

The first resource name to compare, or null.

b GoldengateDeploymentName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a GoldengateDeploymentName

The first resource name to compare, or null.

b GoldengateDeploymentName

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.