public sealed class ChannelName : IResourceName, IEquatable<ChannelName>
Reference documentation and code samples for the Cloud Functions v2 API class ChannelName.
Resource name for the Channel
resource.
Namespace
Google.Cloud.Functions.V2Assembly
Google.Cloud.Functions.V2.dll
Constructors
ChannelName(string, string, string)
public ChannelName(string projectId, string locationId, string channelId)
Constructs a new instance of a ChannelName class from the component parts of pattern
projects/{project}/locations/{location}/channels/{channel}
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
channelId |
string The |
Properties
ChannelId
public string ChannelId { get; }
The Channel
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 ChannelName.ResourceNameType Type { get; }
The ChannelName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
ChannelNameResourceNameType |
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 channelId)
Formats the IDs into the string representation of this ChannelName with pattern
projects/{project}/locations/{location}/channels/{channel}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
channelId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this ChannelName with pattern
|
FormatProjectLocationChannel(string, string, string)
public static string FormatProjectLocationChannel(string projectId, string locationId, string channelId)
Formats the IDs into the string representation of this ChannelName with pattern
projects/{project}/locations/{location}/channels/{channel}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
channelId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this ChannelName with pattern
|
FromProjectLocationChannel(string, string, string)
public static ChannelName FromProjectLocationChannel(string projectId, string locationId, string channelId)
Creates a ChannelName with the pattern
projects/{project}/locations/{location}/channels/{channel}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
channelId |
string The |
Returns | |
---|---|
Type | Description |
ChannelName |
A new instance of ChannelName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static ChannelName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a ChannelName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName |
UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
ChannelName |
A new instance of ChannelName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static ChannelName Parse(string channelName)
Parses the given resource name string into a new ChannelName instance.
Parameter | |
---|---|
Name | Description |
channelName |
string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
ChannelName |
The parsed ChannelName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/channels/{channel}
Parse(string, bool)
public static ChannelName Parse(string channelName, bool allowUnparsed)
Parses the given resource name string into a new ChannelName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
channelName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
Returns | |
---|---|
Type | Description |
ChannelName |
The parsed ChannelName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/channels/{channel}
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 ChannelName)
public static bool TryParse(string channelName, out ChannelName result)
Tries to parse the given resource name string into a new ChannelName instance.
Parameters | |
---|---|
Name | Description |
channelName |
string The resource name in string form. Must not be |
result |
ChannelName When this method returns, the parsed ChannelName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/channels/{channel}
TryParse(string, bool, out ChannelName)
public static bool TryParse(string channelName, bool allowUnparsed, out ChannelName result)
Tries to parse the given resource name string into a new ChannelName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
channelName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
result |
ChannelName When this method returns, the parsed ChannelName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/channels/{channel}
allowUnparsed
is true
.
Operators
operator ==(ChannelName, ChannelName)
public static bool operator ==(ChannelName a, ChannelName b)
Determines whether two specified resource names have the same value.
Parameters | |
---|---|
Name | Description |
a |
ChannelName The first resource name to compare, or null. |
b |
ChannelName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |
operator !=(ChannelName, ChannelName)
public static bool operator !=(ChannelName a, ChannelName b)
Determines whether two specified resource names have different values.
Parameters | |
---|---|
Name | Description |
a |
ChannelName The first resource name to compare, or null. |
b |
ChannelName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |