Integration Connectors v1 API - Class ConnectionSchemaMetadataName (1.3.0)

public sealed class ConnectionSchemaMetadataName : IResourceName, IEquatable<ConnectionSchemaMetadataName>

Reference documentation and code samples for the Integration Connectors v1 API class ConnectionSchemaMetadataName.

Resource name for the ConnectionSchemaMetadata resource.

Inheritance

object > ConnectionSchemaMetadataName

Namespace

Google.Cloud.Connectors.V1

Assembly

Google.Cloud.Connectors.V1.dll

Constructors

ConnectionSchemaMetadataName(string, string, string)

public ConnectionSchemaMetadataName(string projectId, string locationId, string connectionId)

Constructs a new instance of a ConnectionSchemaMetadataName class from the component parts of pattern projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata

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.

connectionId string

The Connection ID. Must not be null or empty.

Properties

ConnectionId

public string ConnectionId { get; }

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

The ConnectionSchemaMetadataName.ResourceNameType of the contained resource name.

Property Value
Type Description
ConnectionSchemaMetadataNameResourceNameType

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

Formats the IDs into the string representation of this ConnectionSchemaMetadataName with pattern projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata.

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.

connectionId string

The Connection ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ConnectionSchemaMetadataName with pattern projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata.

FormatProjectLocationConnection(string, string, string)

public static string FormatProjectLocationConnection(string projectId, string locationId, string connectionId)

Formats the IDs into the string representation of this ConnectionSchemaMetadataName with pattern projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata.

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.

connectionId string

The Connection ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ConnectionSchemaMetadataName with pattern projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata.

FromProjectLocationConnection(string, string, string)

public static ConnectionSchemaMetadataName FromProjectLocationConnection(string projectId, string locationId, string connectionId)

Creates a ConnectionSchemaMetadataName with the pattern projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata.

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.

connectionId string

The Connection ID. Must not be null or empty.

Returns
Type Description
ConnectionSchemaMetadataName

A new instance of ConnectionSchemaMetadataName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ConnectionSchemaMetadataName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ConnectionSchemaMetadataName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
ConnectionSchemaMetadataName

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

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

Parameter
Name Description
connectionSchemaMetadataName string

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

Returns
Type Description
ConnectionSchemaMetadataName

The parsed ConnectionSchemaMetadataName if successful.

Remarks

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

  • projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata

Parse(string, bool)

public static ConnectionSchemaMetadataName Parse(string connectionSchemaMetadataName, bool allowUnparsed)

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

Parameters
Name Description
connectionSchemaMetadataName 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
ConnectionSchemaMetadataName

The parsed ConnectionSchemaMetadataName if successful.

Remarks

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

  • projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata
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 ConnectionSchemaMetadataName)

public static bool TryParse(string connectionSchemaMetadataName, out ConnectionSchemaMetadataName result)

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

Parameters
Name Description
connectionSchemaMetadataName string

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

result ConnectionSchemaMetadataName

When this method returns, the parsed ConnectionSchemaMetadataName, 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}/connections/{connection}/connectionSchemaMetadata

TryParse(string, bool, out ConnectionSchemaMetadataName)

public static bool TryParse(string connectionSchemaMetadataName, bool allowUnparsed, out ConnectionSchemaMetadataName result)

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

Parameters
Name Description
connectionSchemaMetadataName 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 ConnectionSchemaMetadataName

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

Operators

operator ==(ConnectionSchemaMetadataName, ConnectionSchemaMetadataName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ConnectionSchemaMetadataName

The first resource name to compare, or null.

b ConnectionSchemaMetadataName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ConnectionSchemaMetadataName

The first resource name to compare, or null.

b ConnectionSchemaMetadataName

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.