Integration Connectors v1 API - Class ConnectorVersionName (1.0.0)

public sealed class ConnectorVersionName : IResourceName, IEquatable<ConnectorVersionName>

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

Resource name for the ConnectorVersion resource.

Inheritance

object > ConnectorVersionName

Namespace

Google.Cloud.Connectors.V1

Assembly

Google.Cloud.Connectors.V1.dll

Constructors

ConnectorVersionName(string, string, string, string, string)

public ConnectorVersionName(string projectId, string locationId, string providerId, string connectorId, string versionId)

Constructs a new instance of a ConnectorVersionName class from the component parts of pattern projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

providerIdstring

The Provider ID. Must not be null or empty.

connectorIdstring

The Connector ID. Must not be null or empty.

versionIdstring

The Version ID. Must not be null or empty.

Properties

ConnectorId

public string ConnectorId { get; }

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

Property Value
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

ProviderId

public string ProviderId { get; }

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

Property Value
TypeDescription
string

Type

public ConnectorVersionName.ResourceNameType Type { get; }

The ConnectorVersionName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ConnectorVersionNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

VersionId

public string VersionId { get; }

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

Property Value
TypeDescription
string

Methods

Format(string, string, string, string, string)

public static string Format(string projectId, string locationId, string providerId, string connectorId, string versionId)

Formats the IDs into the string representation of this ConnectorVersionName with pattern projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} .

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

providerIdstring

The Provider ID. Must not be null or empty.

connectorIdstring

The Connector ID. Must not be null or empty.

versionIdstring

The Version ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ConnectorVersionName with pattern projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} .

FormatProjectLocationProviderConnectorVersion(string, string, string, string, string)

public static string FormatProjectLocationProviderConnectorVersion(string projectId, string locationId, string providerId, string connectorId, string versionId)

Formats the IDs into the string representation of this ConnectorVersionName with pattern projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} .

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

providerIdstring

The Provider ID. Must not be null or empty.

connectorIdstring

The Connector ID. Must not be null or empty.

versionIdstring

The Version ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ConnectorVersionName with pattern projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} .

FromProjectLocationProviderConnectorVersion(string, string, string, string, string)

public static ConnectorVersionName FromProjectLocationProviderConnectorVersion(string projectId, string locationId, string providerId, string connectorId, string versionId)

Creates a ConnectorVersionName with the pattern projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} .

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

providerIdstring

The Provider ID. Must not be null or empty.

connectorIdstring

The Connector ID. Must not be null or empty.

versionIdstring

The Version ID. Must not be null or empty.

Returns
TypeDescription
ConnectorVersionName

A new instance of ConnectorVersionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ConnectorVersionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ConnectorVersionName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ConnectorVersionName

A new instance of ConnectorVersionName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static ConnectorVersionName Parse(string connectorVersionName)

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

Parameter
NameDescription
connectorVersionNamestring

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

Returns
TypeDescription
ConnectorVersionName

The parsed ConnectorVersionName if successful.

Remarks

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

  • projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version}

Parse(string, bool)

public static ConnectorVersionName Parse(string connectorVersionName, bool allowUnparsed)

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

Parameters
NameDescription
connectorVersionNamestring

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

allowUnparsedbool

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
TypeDescription
ConnectorVersionName

The parsed ConnectorVersionName if successful.

Remarks

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

  • projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
string

The string representation of the resource name.

Overrides

TryParse(string, out ConnectorVersionName)

public static bool TryParse(string connectorVersionName, out ConnectorVersionName result)

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

Parameters
NameDescription
connectorVersionNamestring

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

resultConnectorVersionName

When this method returns, the parsed ConnectorVersionName, or null if parsing failed.

Returns
TypeDescription
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}/providers/{provider}/connectors/{connector}/versions/{version}

TryParse(string, bool, out ConnectorVersionName)

public static bool TryParse(string connectorVersionName, bool allowUnparsed, out ConnectorVersionName result)

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

Parameters
NameDescription
connectorVersionNamestring

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

allowUnparsedbool

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.

resultConnectorVersionName

When this method returns, the parsed ConnectorVersionName, or null if parsing failed.

Returns
TypeDescription
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}/providers/{provider}/connectors/{connector}/versions/{version}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ConnectorVersionName, ConnectorVersionName)

public static bool operator ==(ConnectorVersionName a, ConnectorVersionName b)
Parameters
NameDescription
aConnectorVersionName
bConnectorVersionName
Returns
TypeDescription
bool

operator !=(ConnectorVersionName, ConnectorVersionName)

public static bool operator !=(ConnectorVersionName a, ConnectorVersionName b)
Parameters
NameDescription
aConnectorVersionName
bConnectorVersionName
Returns
TypeDescription
bool