Eventarc v1 API - Class GoogleChannelConfigName (2.1.0)

public sealed class GoogleChannelConfigName : IResourceName, IEquatable<GoogleChannelConfigName>

Reference documentation and code samples for the Eventarc v1 API class GoogleChannelConfigName.

Resource name for the GoogleChannelConfig resource.

Inheritance

Object > GoogleChannelConfigName

Namespace

Google.Cloud.Eventarc.V1

Assembly

Google.Cloud.Eventarc.V1.dll

Constructors

GoogleChannelConfigName(String, String)

public GoogleChannelConfigName(string projectId, string locationId)

Constructs a new instance of a GoogleChannelConfigName class from the component parts of pattern projects/{project}/locations/{location}/googleChannelConfig

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

Properties

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 GoogleChannelConfigName.ResourceNameType Type { get; }

The GoogleChannelConfigName.ResourceNameType of the contained resource name.

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

public static string Format(string projectId, string locationId)

Formats the IDs into the string representation of this GoogleChannelConfigName with pattern projects/{project}/locations/{location}/googleChannelConfig.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this GoogleChannelConfigName with pattern projects/{project}/locations/{location}/googleChannelConfig.

FormatProjectLocation(String, String)

public static string FormatProjectLocation(string projectId, string locationId)

Formats the IDs into the string representation of this GoogleChannelConfigName with pattern projects/{project}/locations/{location}/googleChannelConfig.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this GoogleChannelConfigName with pattern projects/{project}/locations/{location}/googleChannelConfig.

FromProjectLocation(String, String)

public static GoogleChannelConfigName FromProjectLocation(string projectId, string locationId)

Creates a GoogleChannelConfigName with the pattern projects/{project}/locations/{location}/googleChannelConfig.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

Returns
TypeDescription
GoogleChannelConfigName

A new instance of GoogleChannelConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static GoogleChannelConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GoogleChannelConfigName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
GoogleChannelConfigName

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

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

Parameter
NameDescription
googleChannelConfigNameString

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

Returns
TypeDescription
GoogleChannelConfigName

The parsed GoogleChannelConfigName if successful.

Remarks

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

  • projects/{project}/locations/{location}/googleChannelConfig

Parse(String, Boolean)

public static GoogleChannelConfigName Parse(string googleChannelConfigName, bool allowUnparsed)

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

Parameters
NameDescription
googleChannelConfigNameString

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
GoogleChannelConfigName

The parsed GoogleChannelConfigName if successful.

Remarks

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

  • projects/{project}/locations/{location}/googleChannelConfig
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 GoogleChannelConfigName)

public static bool TryParse(string googleChannelConfigName, out GoogleChannelConfigName result)

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

Parameters
NameDescription
googleChannelConfigNameString

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

resultGoogleChannelConfigName

When this method returns, the parsed GoogleChannelConfigName, 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}/googleChannelConfig

TryParse(String, Boolean, out GoogleChannelConfigName)

public static bool TryParse(string googleChannelConfigName, bool allowUnparsed, out GoogleChannelConfigName result)

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

Parameters
NameDescription
googleChannelConfigNameString

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.

resultGoogleChannelConfigName

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

Operators

Equality(GoogleChannelConfigName, GoogleChannelConfigName)

public static bool operator ==(GoogleChannelConfigName a, GoogleChannelConfigName b)
Parameters
NameDescription
aGoogleChannelConfigName
bGoogleChannelConfigName
Returns
TypeDescription
Boolean

Inequality(GoogleChannelConfigName, GoogleChannelConfigName)

public static bool operator !=(GoogleChannelConfigName a, GoogleChannelConfigName b)
Parameters
NameDescription
aGoogleChannelConfigName
bGoogleChannelConfigName
Returns
TypeDescription
Boolean