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.
Namespace
Google.Cloud.Functions.V1Assembly
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 |
locationId | String The |
functionId | String The |
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 |
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 CloudFunctionName.ResourceNameType Type { get; }
The CloudFunctionName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
CloudFunctionName.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 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 |
locationId | String The |
functionId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this CloudFunctionName with pattern
|
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 |
locationId | String The |
functionId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this CloudFunctionName with pattern
|
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 |
locationId | String The |
functionId | String The |
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 |
Returns | |
---|---|
Type | Description |
CloudFunctionName | A new instance of CloudFunctionName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
Int32 |
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 |
Returns | |
---|---|
Type | Description |
CloudFunctionName | The parsed CloudFunctionName if successful. |
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 | |
---|---|
Name | Description |
cloudFunctionName | String The resource name in string form. Must not be |
allowUnparsed | Boolean If |
Returns | |
---|---|
Type | Description |
CloudFunctionName | The parsed CloudFunctionName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/functions/{function}
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. |
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 |
result | CloudFunctionName When this method returns, the parsed CloudFunctionName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
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 | |
---|---|
Name | Description |
cloudFunctionName | String The resource name in string form. Must not be |
allowUnparsed | Boolean If |
result | CloudFunctionName When this method returns, the parsed CloudFunctionName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/functions/{function}
allowUnparsed
is true
.
Operators
Equality(CloudFunctionName, CloudFunctionName)
public static bool operator ==(CloudFunctionName a, CloudFunctionName b)
Parameters | |
---|---|
Name | Description |
a | CloudFunctionName |
b | CloudFunctionName |
Returns | |
---|---|
Type | Description |
Boolean |
Inequality(CloudFunctionName, CloudFunctionName)
public static bool operator !=(CloudFunctionName a, CloudFunctionName b)
Parameters | |
---|---|
Name | Description |
a | CloudFunctionName |
b | CloudFunctionName |
Returns | |
---|---|
Type | Description |
Boolean |