Cloud Functions v2 API - Class ConnectorName (1.1.0)

public sealed class ConnectorName : IResourceName, IEquatable<ConnectorName>

Reference documentation and code samples for the Cloud Functions v2 API class ConnectorName.

Resource name for the Connector resource.

Inheritance

Object > ConnectorName

Implements

IResourceName, IEquatable<ConnectorName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Functions.V2

Assembly

Google.Cloud.Functions.V2.dll

Constructors

ConnectorName(String, String, String)

public ConnectorName(string projectId, string locationId, string connectorId)

Constructs a new instance of a ConnectorName class from the component parts of pattern projects/{project}/locations/{location}/connectors/{connector}

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.
`connectorId`	`String` The `Connector` 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
`Boolean`

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 ConnectorName.ResourceNameType Type { get; }

The ConnectorName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ConnectorName.ResourceNameType`

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

Formats the IDs into the string representation of this ConnectorName with pattern projects/{project}/locations/{location}/connectors/{connector}.

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.
`connectorId`	`String` The `Connector` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this ConnectorName with pattern `projects/{project}/locations/{location}/connectors/{connector}`.

FormatProjectLocationConnector(String, String, String)

public static string FormatProjectLocationConnector(string projectId, string locationId, string connectorId)

Formats the IDs into the string representation of this ConnectorName with pattern projects/{project}/locations/{location}/connectors/{connector}.

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.
`connectorId`	`String` The `Connector` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this ConnectorName with pattern `projects/{project}/locations/{location}/connectors/{connector}`.

FromProjectLocationConnector(String, String, String)

public static ConnectorName FromProjectLocationConnector(string projectId, string locationId, string connectorId)

Creates a ConnectorName with the pattern projects/{project}/locations/{location}/connectors/{connector}.

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.
`connectorId`	`String` The `Connector` ID. Must not be `null` or empty.

Returns
Type	Description
`ConnectorName`	A new instance of ConnectorName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ConnectorName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ConnectorName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

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

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static ConnectorName Parse(string connectorName)

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

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

Returns
Type	Description
`ConnectorName`	The parsed ConnectorName if successful.

Remarks

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

projects/{project}/locations/{location}/connectors/{connector}

Parse(String, Boolean)

public static ConnectorName Parse(string connectorName, bool allowUnparsed)

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

Parameters
Name	Description
`connectorName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
`ConnectorName`	The parsed ConnectorName if successful.

Remarks

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

projects/{project}/locations/{location}/connectors/{connector}

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

public static bool TryParse(string connectorName, out ConnectorName result)

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

Parameters
Name	Description
`connectorName`	`String` The resource name in string form. Must not be `null`.
`result`	`ConnectorName` When this method returns, the parsed ConnectorName, or `null` if parsing failed.

Returns
Type	Description
`Boolean`	`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}/connectors/{connector}

TryParse(String, Boolean, out ConnectorName)

public static bool TryParse(string connectorName, bool allowUnparsed, out ConnectorName result)

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

Parameters
Name	Description
`connectorName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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`	`ConnectorName` When this method returns, the parsed ConnectorName, or `null` if parsing failed.

Returns
Type	Description
`Boolean`	`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}/connectors/{connector}

Or may be in any format if allowUnparsed is true.

Operators

Equality(ConnectorName, ConnectorName)

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

Parameters
Name	Description
`a`	`ConnectorName`
`b`	`ConnectorName`

Returns
Type	Description
`Boolean`

Inequality(ConnectorName, ConnectorName)

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

Parameters
Name	Description
`a`	`ConnectorName`
`b`	`ConnectorName`

Returns
Type	Description
`Boolean`