Class FunctionName (1.0.0-beta01)

public sealed class FunctionName : IResourceName, IEquatable<FunctionName>

Resource name for the Function resource.

Inheritance

System.Object > FunctionName

Implements

IResourceName, System.IEquatable<FunctionName>

Namespace

Google.Cloud.Functions.V2Beta

Assembly

Google.Cloud.Functions.V2Beta.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
NameDescription
projectIdSystem.String

The Project ID. Must not be null or empty.

locationIdSystem.String

The Location ID. Must not be null or empty.

functionIdSystem.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
TypeDescription
System.String

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
System.Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
System.String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
System.String

Type

public FunctionName.ResourceNameType Type { get; }

The FunctionName.ResourceNameType of the contained resource name.

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

Parameters
NameDescription
projectIdSystem.String

The Project ID. Must not be null or empty.

locationIdSystem.String

The Location ID. Must not be null or empty.

functionIdSystem.String

The Function ID. Must not be null or empty.

Returns
TypeDescription
System.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
NameDescription
projectIdSystem.String

The Project ID. Must not be null or empty.

locationIdSystem.String

The Location ID. Must not be null or empty.

functionIdSystem.String

The Function ID. Must not be null or empty.

Returns
TypeDescription
System.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
NameDescription
projectIdSystem.String

The Project ID. Must not be null or empty.

locationIdSystem.String

The Location ID. Must not be null or empty.

functionIdSystem.String

The Function ID. Must not be null or empty.

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

The unparsed resource name. Must not be null.

Returns
TypeDescription
FunctionName

A new instance of FunctionName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
System.Int32
Overrides
System.Object.GetHashCode()

Parse(String)

public static FunctionName Parse(string functionName)

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

Parameter
NameDescription
functionNameSystem.String

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

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

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
NameDescription
functionNameSystem.String

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

allowUnparsedSystem.Boolean

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.

Returns
TypeDescription
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
TypeDescription
System.String

The string representation of the resource name.

Overrides
System.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
NameDescription
functionNameSystem.String

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

resultFunctionName

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

Returns
TypeDescription
System.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 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
NameDescription
functionNameSystem.String

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

allowUnparsedSystem.Boolean

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.

resultFunctionName

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

Returns
TypeDescription
System.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(FunctionName, FunctionName)

public static bool operator ==(FunctionName a, FunctionName b)
Parameters
NameDescription
aFunctionName
bFunctionName
Returns
TypeDescription
System.Boolean

Inequality(FunctionName, FunctionName)

public static bool operator !=(FunctionName a, FunctionName b)
Parameters
NameDescription
aFunctionName
bFunctionName
Returns
TypeDescription
System.Boolean