Class TopicName

Resource name for the Topic resource.

Inheritance

System.Object

TopicName

Implements

IResourceName

System.IEquatable<TopicName>

Inherited Members

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Cloud.PubSub.V1

Assembly: Google.Cloud.PubSub.V1.dll

Syntax

public sealed class TopicName : IResourceName, IEquatable<TopicName>

Constructors

TopicName(String, String)

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

Declaration

public TopicName(string projectId, string topicId)

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	topicId	The Topic ID. Must not be null or empty.

Properties

IsKnownPattern

Whether this instance contains a resource name with a known pattern.

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
System.Boolean

Implements

IResourceName.IsKnownPattern

ProjectId

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

Declaration

public string ProjectId { get; }

Property Value

Type	Description
System.String

TopicId

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

Declaration

public string TopicId { get; }

Property Value

Type	Description
System.String

Type

The TopicName.ResourceNameType of the contained resource name.

Declaration

public TopicName.ResourceNameType Type { get; }

Property Value

Type	Description
TopicName.ResourceNameType

UnparsedResource

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
UnparsedResourceName

Methods

Format(String, String)

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

Declaration

public static string Format(string projectId, string topicId)

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	topicId	The Topic ID. Must not be null or empty.

Returns

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

FormatDeletedTopic()

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

Declaration

public static string FormatDeletedTopic()

Returns

Type	Description
System.String	The string representation of this TopicName with pattern deleted-topic.

FormatProjectTopic(String, String)

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

Declaration

public static string FormatProjectTopic(string projectId, string topicId)

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	topicId	The Topic ID. Must not be null or empty.

Returns

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

FromDeletedTopic()

Creates a TopicName with the pattern deleted-topic.

Declaration

public static TopicName FromDeletedTopic()

Returns

Type	Description
TopicName	A new instance of TopicName constructed from the provided ids.

FromProjectTopic(String, String)

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

Declaration

public static TopicName FromProjectTopic(string projectId, string topicId)

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	topicId	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)

Creates a TopicName containing an unparsed resource name.

Declaration

public static TopicName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

Type	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()

Returns a hash code for this resource name.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

Parse(String)

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

Declaration

public static TopicName Parse(string topicName)

Parameters

Type	Name	Description
System.String	topicName	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, Boolean)

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

Declaration

public static TopicName Parse(string topicName, bool allowUnparsed)

Parameters

Type	Name	Description
System.String	topicName	The resource name in string form. Must not be null.
System.Boolean	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.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()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
System.String	The string representation of the resource name.

Overrides

System.Object.ToString()

Implements

IResourceName.ToString()

TryParse(String, out TopicName)

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

Declaration

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

Parameters

Type	Name	Description
System.String	topicName	The resource name in string form. Must not be null.
TopicName	result	When this method returns, the parsed TopicName, or null if parsing failed.

Returns

Type	Description
System.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}/topics/{topic}
• deleted-topic

TryParse(String, Boolean, out TopicName)

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

Declaration

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

Parameters

Type	Name	Description
System.String	topicName	The resource name in string form. Must not be null.
System.Boolean	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.
TopicName	result	When this method returns, the parsed TopicName, or null if parsing failed.

Returns

Type	Description
System.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}/topics/{topic}
• deleted-topic

Or may be in any format if allowUnparsed is true.

Operators

Equality(TopicName, TopicName)

Declaration

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

Parameters

Type	Name	Description
TopicName	a
TopicName	b

Returns

Type	Description
System.Boolean

Inequality(TopicName, TopicName)

Declaration

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

Parameters

Type	Name	Description
TopicName	a
TopicName	b

Returns

Type	Description
System.Boolean