Cloud Functions v2 API - Class ChannelName (1.2.0)

Version 1.2.0

• 1.7.0 (latest)
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

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.

Inheritance

object > ChannelName

Implements

IResourceName, IEquatableChannelName

Inherited Members

object.GetType()

Namespace

GoogleCloudGoogle.Cloud.FunctionsV2

Assembly

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 Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
channelId	string The Channel ID. Must not be null or empty.

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 Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
channelId	string The Channel ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ChannelName with pattern projects/{project}/locations/{location}/channels/{channel}.

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 Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
channelId	string The Channel ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ChannelName with pattern projects/{project}/locations/{location}/channels/{channel}.

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 Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
channelId	string The Channel ID. Must not be null or empty.

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 null.

Returns
Type	Description
ChannelName	A new instance of ChannelName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

Object.GetHashCode()

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 null.

Returns
Type	Description
ChannelName	The parsed ChannelName if successful.

Remarks

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 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
ChannelName	The parsed ChannelName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• projects/{project}/locations/{location}/channels/{channel}

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

Object.ToString()

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 null.
result	ChannelName When this method returns, the parsed ChannelName, 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}/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 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	ChannelName When this method returns, the parsed ChannelName, 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}/channels/{channel}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ChannelName, ChannelName)

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

Parameters
Name	Description
a	ChannelName
b	ChannelName

Returns
Type	Description
bool

operator !=(ChannelName, ChannelName)

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

Parameters
Name	Description
a	ChannelName
b	ChannelName

Returns
Type	Description
bool