Cloud Functions v1 API - Class CloudFunctionName (2.5.0) 

public sealed class CloudFunctionName : IResourceName, IEquatable<CloudFunctionName>

Reference documentation and code samples for the Cloud Functions v1 API class CloudFunctionName.

Resource name for the CloudFunction resource.

Inheritance

object > CloudFunctionName

Namespace

Google.Cloud.Functions.V1

Assembly

Google.Cloud.Functions.V1.dll

Constructors

CloudFunctionName(string, string, string)

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

Constructs a new instance of a CloudFunctionName 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 CloudFunctionName.ResourceNameType Type { get; }

The CloudFunctionName.ResourceNameType of the contained resource name.

Property Value
Type Description
CloudFunctionNameResourceNameType

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 CloudFunctionName 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 CloudFunctionName 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 CloudFunctionName 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 CloudFunctionName with pattern projects/{project}/locations/{location}/functions/{function}.

FromProjectLocationFunction(string, string, string)

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

Creates a CloudFunctionName 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
CloudFunctionName

A new instance of CloudFunctionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CloudFunctionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CloudFunctionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
CloudFunctionName

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

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

Parameter
Name Description
cloudFunctionName string

The resource name in string form. Must not be null.
Returns
Type Description
CloudFunctionName

The parsed CloudFunctionName 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 CloudFunctionName Parse(string cloudFunctionName, bool allowUnparsed)

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

Parameters
Name Description
cloudFunctionName 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
CloudFunctionName

The parsed CloudFunctionName 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

TryParse(string, out CloudFunctionName)

public static bool TryParse(string cloudFunctionName, out CloudFunctionName result)

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

Parameters
Name Description
cloudFunctionName string

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

When this method returns, the parsed CloudFunctionName, 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 CloudFunctionName)

public static bool TryParse(string cloudFunctionName, bool allowUnparsed, out CloudFunctionName result)

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

Parameters
Name Description
cloudFunctionName 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 CloudFunctionName

When this method returns, the parsed CloudFunctionName, 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 ==(CloudFunctionName, CloudFunctionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a CloudFunctionName

The first resource name to compare, or null.
b CloudFunctionName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a CloudFunctionName

The first resource name to compare, or null.
b CloudFunctionName

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.