Cloud Functions v2 API - Class FunctionName (1.3.0)

public sealed class FunctionName : IResourceName, IEquatable<FunctionName>

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

Resource name for the Function resource.

Inheritance

object > FunctionName

Implements

IResourceName, IEquatable FunctionName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Functions.V2

Assembly

Google.Cloud.Functions.V2.dll

Constructors

FunctionName(string, string, string)

public FunctionName(string projectId, string locationId, string functionId)

Constructs a new instance of a FunctionName class from the component parts of pattern projects/{project}/locations/{location}/functions/{function}

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.
`functionId`	`string` The `Function` ID. Must not be `null` or empty.

Properties

FunctionId

public string FunctionId { get; }

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

The FunctionName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`FunctionNameResourceNameType`

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

Formats the IDs into the string representation of this FunctionName with pattern projects/{project}/locations/{location}/functions/{function}.

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.
`functionId`	`string` The `Function` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this FunctionName with pattern `projects/{project}/locations/{location}/functions/{function}`.

FormatProjectLocationFunction(string, string, string)

public static string FormatProjectLocationFunction(string projectId, string locationId, string functionId)

Formats the IDs into the string representation of this FunctionName with pattern projects/{project}/locations/{location}/functions/{function}.

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.
`functionId`	`string` The `Function` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this FunctionName with pattern `projects/{project}/locations/{location}/functions/{function}`.

FromProjectLocationFunction(string, string, string)

public static FunctionName FromProjectLocationFunction(string projectId, string locationId, string functionId)

Creates a FunctionName with the pattern projects/{project}/locations/{location}/functions/{function}.

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.
`functionId`	`string` The `Function` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static FunctionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FunctionName containing an unparsed resource name.

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

Returns
Type	Description
`FunctionName`	A new instance of FunctionName 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 FunctionName Parse(string functionName)

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

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

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

Remarks

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

projects/{project}/locations/{location}/functions/{function}

Parse(string, bool)

public static FunctionName Parse(string functionName, bool allowUnparsed)

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

Parameters
Name	Description
`functionName`	`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
`FunctionName`	The parsed FunctionName if successful.

Remarks

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

projects/{project}/locations/{location}/functions/{function}

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

public static bool TryParse(string functionName, out FunctionName result)

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

Parameters
Name	Description
`functionName`	`string` The resource name in string form. Must not be `null`.
`result`	`FunctionName` When this method returns, the parsed FunctionName, 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}/functions/{function}

TryParse(string, bool, out FunctionName)

public static bool TryParse(string functionName, bool allowUnparsed, out FunctionName result)

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

Parameters
Name	Description
`functionName`	`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`	`FunctionName` When this method returns, the parsed FunctionName, 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}/functions/{function}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(FunctionName, FunctionName)

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

Parameters
Name	Description
`a`	`FunctionName`
`b`	`FunctionName`

Returns
Type	Description
`bool`

operator !=(FunctionName, FunctionName)

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

Parameters
Name	Description
`a`	`FunctionName`
`b`	`FunctionName`

Returns
Type	Description
`bool`