Class ChannelConnectionName (2.0.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class ChannelConnectionName : IResourceName, IEquatable<ChannelConnectionName>

Resource name for the ChannelConnection resource.

Inheritance

Object > ChannelConnectionName

Namespace

Google.Cloud.Eventarc.V1

Assembly

Google.Cloud.Eventarc.V1.dll

Constructors

ChannelConnectionName(String, String, String)

public ChannelConnectionName(string projectId, string locationId, string channelConnectionId)

Constructs a new instance of a ChannelConnectionName class from the component parts of pattern projects/{project}/locations/{location}/channelConnections/{channel_connection}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

channelConnectionIdString

The ChannelConnection ID. Must not be null or empty.

Properties

ChannelConnectionId

public string ChannelConnectionId { get; }

The ChannelConnection 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 ChannelConnectionName.ResourceNameType Type { get; }

The ChannelConnectionName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ChannelConnectionName.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 channelConnectionId)

Formats the IDs into the string representation of this ChannelConnectionName with pattern projects/{project}/locations/{location}/channelConnections/{channel_connection}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

channelConnectionIdString

The ChannelConnection ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ChannelConnectionName with pattern projects/{project}/locations/{location}/channelConnections/{channel_connection}.

FormatProjectLocationChannelConnection(String, String, String)

public static string FormatProjectLocationChannelConnection(string projectId, string locationId, string channelConnectionId)

Formats the IDs into the string representation of this ChannelConnectionName with pattern projects/{project}/locations/{location}/channelConnections/{channel_connection}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

channelConnectionIdString

The ChannelConnection ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ChannelConnectionName with pattern projects/{project}/locations/{location}/channelConnections/{channel_connection}.

FromProjectLocationChannelConnection(String, String, String)

public static ChannelConnectionName FromProjectLocationChannelConnection(string projectId, string locationId, string channelConnectionId)

Creates a ChannelConnectionName with the pattern projects/{project}/locations/{location}/channelConnections/{channel_connection}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

channelConnectionIdString

The ChannelConnection ID. Must not be null or empty.

Returns
TypeDescription
ChannelConnectionName

A new instance of ChannelConnectionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ChannelConnectionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ChannelConnectionName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ChannelConnectionName

A new instance of ChannelConnectionName 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 ChannelConnectionName Parse(string channelConnectionName)

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

Parameter
NameDescription
channelConnectionNameString

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

Returns
TypeDescription
ChannelConnectionName

The parsed ChannelConnectionName if successful.

Remarks

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

  • projects/{project}/locations/{location}/channelConnections/{channel_connection}

Parse(String, Boolean)

public static ChannelConnectionName Parse(string channelConnectionName, bool allowUnparsed)

Parses the given resource name string into a new ChannelConnectionName instance; optionally allowing an unparseable resource name.

Parameters
NameDescription
channelConnectionNameString

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
ChannelConnectionName

The parsed ChannelConnectionName if successful.

Remarks

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

  • projects/{project}/locations/{location}/channelConnections/{channel_connection}
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 ChannelConnectionName)

public static bool TryParse(string channelConnectionName, out ChannelConnectionName result)

Tries to parse the given resource name string into a new ChannelConnectionName instance.

Parameters
NameDescription
channelConnectionNameString

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

resultChannelConnectionName

When this method returns, the parsed ChannelConnectionName, 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}/channelConnections/{channel_connection}

TryParse(String, Boolean, out ChannelConnectionName)

public static bool TryParse(string channelConnectionName, bool allowUnparsed, out ChannelConnectionName result)

Tries to parse the given resource name string into a new ChannelConnectionName instance; optionally allowing an unparseable resource name.

Parameters
NameDescription
channelConnectionNameString

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.

resultChannelConnectionName

When this method returns, the parsed ChannelConnectionName, 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}/channelConnections/{channel_connection}
Or may be in any format if allowUnparsed is true.

Operators

Equality(ChannelConnectionName, ChannelConnectionName)

public static bool operator ==(ChannelConnectionName a, ChannelConnectionName b)
Parameters
NameDescription
aChannelConnectionName
bChannelConnectionName
Returns
TypeDescription
Boolean

Inequality(ChannelConnectionName, ChannelConnectionName)

public static bool operator !=(ChannelConnectionName a, ChannelConnectionName b)
Parameters
NameDescription
aChannelConnectionName
bChannelConnectionName
Returns
TypeDescription
Boolean