Class CloudFunctionName

public sealed class CloudFunctionName : IResourceName, IEquatable<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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

functionIdString

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

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

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

Type

public CloudFunctionName.ResourceNameType Type { get; }

The CloudFunctionName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
CloudFunctionName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

functionIdString

The Function ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

functionIdString

The Function ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

functionIdString

The Function ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
CloudFunctionName

A new instance of CloudFunctionName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static CloudFunctionName Parse(string cloudFunctionName)

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

Parameter
NameDescription
cloudFunctionNameString

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

Returns
TypeDescription
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, Boolean)

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
NameDescription
cloudFunctionNameString

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

allowUnparsedBoolean

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
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
TypeDescription
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
NameDescription
cloudFunctionNameString

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

resultCloudFunctionName

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

Returns
TypeDescription
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}/functions/{function}

TryParse(String, Boolean, 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
NameDescription
cloudFunctionNameString

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

allowUnparsedBoolean

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.

resultCloudFunctionName

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

Returns
TypeDescription
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}/functions/{function}
Or may be in any format if allowUnparsed is true.

Operators

Equality(CloudFunctionName, CloudFunctionName)

public static bool operator ==(CloudFunctionName a, CloudFunctionName b)
Parameters
NameDescription
aCloudFunctionName
bCloudFunctionName
Returns
TypeDescription
Boolean

Inequality(CloudFunctionName, CloudFunctionName)

public static bool operator !=(CloudFunctionName a, CloudFunctionName b)
Parameters
NameDescription
aCloudFunctionName
bCloudFunctionName
Returns
TypeDescription
Boolean