Cloud Pub/Sub v1 API - Class TopicName (3.16.0)

public sealed class TopicName : IResourceName, IEquatable<TopicName>

Reference documentation and code samples for the Cloud Pub/Sub v1 API class TopicName.

Resource name for the Topic resource.

Inheritance

object > TopicName

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Constructors

TopicName(string, string)

public TopicName(string projectId, string topicId)

Constructs a new instance of a TopicName class from the component parts of pattern projects/{project}/topics/{topic}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

topicId string

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

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

TopicId

public string TopicId { get; }

The Topic ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

Type

public TopicName.ResourceNameType Type { get; }

The TopicName.ResourceNameType of the contained resource name.

Property Value
Type Description
TopicNameResourceNameType

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)

public static string Format(string projectId, string topicId)

Formats the IDs into the string representation of this TopicName with pattern projects/{project}/topics/{topic}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

topicId string

The Topic ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this TopicName with pattern projects/{project}/topics/{topic} .

FormatDeletedTopic()

public static string FormatDeletedTopic()

Formats the IDs into the string representation of this TopicName with pattern deleted-topic.

Returns
Type Description
string

The string representation of this TopicName with pattern deleted-topic.

FormatProjectTopic(string, string)

public static string FormatProjectTopic(string projectId, string topicId)

Formats the IDs into the string representation of this TopicName with pattern projects/{project}/topics/{topic}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

topicId string

The Topic ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this TopicName with pattern projects/{project}/topics/{topic} .

FromDeletedTopic()

public static TopicName FromDeletedTopic()

Creates a TopicName with the pattern deleted-topic.

Returns
Type Description
TopicName

A new instance of TopicName constructed from the provided ids.

FromProjectTopic(string, string)

public static TopicName FromProjectTopic(string projectId, string topicId)

Creates a TopicName with the pattern projects/{project}/topics/{topic}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

topicId string

The Topic ID. Must not be null or empty.

Returns
Type Description
TopicName

A new instance of TopicName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TopicName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TopicName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
TopicName

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

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

Parameter
Name Description
topicName string

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

Returns
Type Description
TopicName

The parsed TopicName if successful.

Remarks

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

  • projects/{project}/topics/{topic}
  • deleted-topic

Parse(string, bool)

public static TopicName Parse(string topicName, bool allowUnparsed)

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

Parameters
Name Description
topicName 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
TopicName

The parsed TopicName if successful.

Remarks

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

  • projects/{project}/topics/{topic}
  • deleted-topic
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 TopicName)

public static bool TryParse(string topicName, out TopicName result)

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

Parameters
Name Description
topicName string

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

result TopicName

When this method returns, the parsed TopicName, 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}/topics/{topic}
  • deleted-topic

TryParse(string, bool, out TopicName)

public static bool TryParse(string topicName, bool allowUnparsed, out TopicName result)

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

Parameters
Name Description
topicName 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 TopicName

When this method returns, the parsed TopicName, 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}/topics/{topic}
  • deleted-topic
Or may be in any format if allowUnparsed is true.

Operators

operator ==(TopicName, TopicName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a TopicName

The first resource name to compare, or null.

b TopicName

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 !=(TopicName, TopicName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a TopicName

The first resource name to compare, or null.

b TopicName

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.