Integration Connectors v1 API - Class ConnectorVersionName (1.3.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

Implements

IResourceName, IEquatable ConnectorVersionName

Inherited Members

object.GetType()

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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`providerId`	`string` The `Provider` ID. Must not be `null` or empty.
`connectorId`	`string` The `Connector` ID. Must not be `null` or empty.
`versionId`	`string` 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
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`

ProviderId

public string ProviderId { get; }

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

Property Value
Type	Description
`string`

Type

public ConnectorVersionName.ResourceNameType Type { get; }

The ConnectorVersionName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ConnectorVersionNameResourceNameType`

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type	Description
`UnparsedResourceName`

VersionId

public string VersionId { get; }

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

Property Value
Type	Description
`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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`providerId`	`string` The `Provider` ID. Must not be `null` or empty.
`connectorId`	`string` The `Connector` ID. Must not be `null` or empty.
`versionId`	`string` The `Version` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`providerId`	`string` The `Provider` ID. Must not be `null` or empty.
`connectorId`	`string` The `Connector` ID. Must not be `null` or empty.
`versionId`	`string` The `Version` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`providerId`	`string` The `Provider` ID. Must not be `null` or empty.
`connectorId`	`string` The `Connector` ID. Must not be `null` or empty.
`versionId`	`string` The `Version` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`ConnectorVersionName`	A new instance of ConnectorVersionName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static ConnectorVersionName Parse(string connectorVersionName)

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

Parameter
Name	Description
`connectorVersionName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`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
Name	Description
`connectorVersionName`	`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
`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
Type	Description
`string`	The string representation of the resource name.

Overrides

object.ToString()

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
Name	Description
`connectorVersionName`	`string` The resource name in string form. Must not be `null`.
`result`	`ConnectorVersionName` When this method returns, the parsed ConnectorVersionName, 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}/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
Name	Description
`connectorVersionName`	`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`	`ConnectorVersionName` When this method returns, the parsed ConnectorVersionName, 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}/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)

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`ConnectorVersionName` The first resource name to compare, or null.
`b`	`ConnectorVersionName` 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 !=(ConnectorVersionName, ConnectorVersionName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`ConnectorVersionName` The first resource name to compare, or null.
`b`	`ConnectorVersionName` 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.