Google Cloud Security Command Center v1p1beta1 API - Class TopicName (3.0.0-beta04)

public sealed class TopicName : IResourceName, IEquatable<TopicName>

Reference documentation and code samples for the Google Cloud Security Command Center v1p1beta1 API class TopicName.

Resource name for the Topic resource.

Inheritance

object > TopicName

Namespace

Google.Cloud.SecurityCenter.V1P1Beta1

Assembly

Google.Cloud.SecurityCenter.V1P1Beta1.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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

topicIdstring

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
TypeDescription
bool

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

TopicId

public string TopicId { get; }

The Topic ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

Type

public TopicName.ResourceNameType Type { get; }

The TopicName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
TopicNameResourceNameType

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

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

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

topicIdstring

The Topic ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this TopicName with pattern projects/{project}/topics/{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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

topicIdstring

The Topic ID. Must not be null or empty.

Returns
TypeDescription
string

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

FromProjectTopic(string, string)

public static TopicName FromProjectTopic(string projectId, string topicId)

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

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

topicIdstring

The Topic ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
TopicName

A new instance of TopicName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static TopicName Parse(string topicName)

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

Parameter
NameDescription
topicNamestring

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

Returns
TypeDescription
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}

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
NameDescription
topicNamestring

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

allowUnparsedbool

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
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}
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 TopicName)

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

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

Parameters
NameDescription
topicNamestring

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

resultTopicName

When this method returns, the parsed TopicName, or null if parsing failed.

Returns
TypeDescription
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}

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
NameDescription
topicNamestring

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

allowUnparsedbool

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.

resultTopicName

When this method returns, the parsed TopicName, or null if parsing failed.

Returns
TypeDescription
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}
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
NameDescription
aTopicName

The first resource name to compare, or null.

bTopicName

The second resource name to compare, or null.

Returns
TypeDescription
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
NameDescription
aTopicName

The first resource name to compare, or null.

bTopicName

The second resource name to compare, or null.

Returns
TypeDescription
bool

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