Eventarc v1 API - Class MessageBusName (2.7.0) 

public sealed class MessageBusName : IResourceName, IEquatable<MessageBusName>

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

Resource name for the MessageBus resource.

Inheritance

object > MessageBusName

Namespace

Google.Cloud.Eventarc.V1

Assembly

Google.Cloud.Eventarc.V1.dll

Constructors

MessageBusName(string, string, string)

public MessageBusName(string projectId, string locationId, string messageBusId)

Constructs a new instance of a MessageBusName class from the component parts of pattern projects/{project}/locations/{location}/messageBuses/{message_bus}

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.
messageBusId string

The MessageBus 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
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

MessageBusId

public string MessageBusId { get; }

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

The MessageBusName.ResourceNameType of the contained resource name.

Property Value
Type Description
MessageBusNameResourceNameType

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 messageBusId)

Formats the IDs into the string representation of this MessageBusName with pattern projects/{project}/locations/{location}/messageBuses/{message_bus}.

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.
messageBusId string

The MessageBus ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this MessageBusName with pattern projects/{project}/locations/{location}/messageBuses/{message_bus}.

FormatProjectLocationMessageBus(string, string, string)

public static string FormatProjectLocationMessageBus(string projectId, string locationId, string messageBusId)

Formats the IDs into the string representation of this MessageBusName with pattern projects/{project}/locations/{location}/messageBuses/{message_bus}.

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.
messageBusId string

The MessageBus ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this MessageBusName with pattern projects/{project}/locations/{location}/messageBuses/{message_bus}.

FromProjectLocationMessageBus(string, string, string)

public static MessageBusName FromProjectLocationMessageBus(string projectId, string locationId, string messageBusId)

Creates a MessageBusName with the pattern projects/{project}/locations/{location}/messageBuses/{message_bus}.

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.
messageBusId string

The MessageBus ID. Must not be null or empty.
Returns
Type Description
MessageBusName

A new instance of MessageBusName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static MessageBusName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MessageBusName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
MessageBusName

A new instance of MessageBusName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static MessageBusName Parse(string messageBusName)

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

Parameter
Name Description
messageBusName string

The resource name in string form. Must not be null.
Returns
Type Description
MessageBusName

The parsed MessageBusName if successful.
Remarks

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

  • projects/{project}/locations/{location}/messageBuses/{message_bus}

Parse(string, bool)

public static MessageBusName Parse(string messageBusName, bool allowUnparsed)

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

Parameters
Name Description
messageBusName 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
MessageBusName

The parsed MessageBusName if successful.
Remarks

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

  • projects/{project}/locations/{location}/messageBuses/{message_bus}
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

TryParse(string, out MessageBusName)

public static bool TryParse(string messageBusName, out MessageBusName result)

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

Parameters
Name Description
messageBusName string

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

When this method returns, the parsed MessageBusName, 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}/messageBuses/{message_bus}

TryParse(string, bool, out MessageBusName)

public static bool TryParse(string messageBusName, bool allowUnparsed, out MessageBusName result)

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

Parameters
Name Description
messageBusName 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 MessageBusName

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

Operators

operator ==(MessageBusName, MessageBusName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a MessageBusName

The first resource name to compare, or null.
b MessageBusName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(MessageBusName, MessageBusName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a MessageBusName

The first resource name to compare, or null.
b MessageBusName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.