Cloud Pub/Sub v1 API - Class SubscriptionName (3.18.0)

public sealed class SubscriptionName : IResourceName, IEquatable<SubscriptionName>

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

Resource name for the Subscription resource.

Inheritance

object > SubscriptionName

Implements

IResourceName, IEquatable SubscriptionName

Inherited Members

object.GetType()

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Constructors

SubscriptionName(string, string)

public SubscriptionName(string projectId, string subscriptionId)

Constructs a new instance of a SubscriptionName class from the component parts of pattern projects/{project}/subscriptions/{subscription}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`subscriptionId`	`string` The `Subscription` 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. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

SubscriptionId

public string SubscriptionId { get; }

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

Property Value
Type	Description
`string`

Type

public SubscriptionName.ResourceNameType Type { get; }

The SubscriptionName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`SubscriptionNameResourceNameType`

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

Formats the IDs into the string representation of this SubscriptionName with pattern projects/{project}/subscriptions/{subscription}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`subscriptionId`	`string` The `Subscription` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SubscriptionName with pattern `projects/{project}/subscriptions/{subscription}`.

FormatProjectSubscription(string, string)

public static string FormatProjectSubscription(string projectId, string subscriptionId)

Formats the IDs into the string representation of this SubscriptionName with pattern projects/{project}/subscriptions/{subscription}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`subscriptionId`	`string` The `Subscription` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SubscriptionName with pattern `projects/{project}/subscriptions/{subscription}`.

FromProjectSubscription(string, string)

public static SubscriptionName FromProjectSubscription(string projectId, string subscriptionId)

Creates a SubscriptionName with the pattern projects/{project}/subscriptions/{subscription} .

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`subscriptionId`	`string` The `Subscription` ID. Must not be `null` or empty.

Returns
Type	Description
`SubscriptionName`	A new instance of SubscriptionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SubscriptionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SubscriptionName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`SubscriptionName`	A new instance of SubscriptionName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static SubscriptionName Parse(string subscriptionName)

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

Parameter
Name	Description
`subscriptionName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`SubscriptionName`	The parsed SubscriptionName if successful.

Remarks

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

projects/{project}/subscriptions/{subscription}

Parse(string, bool)

public static SubscriptionName Parse(string subscriptionName, bool allowUnparsed)

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

Parameters
Name	Description
`subscriptionName`	`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
`SubscriptionName`	The parsed SubscriptionName if successful.

Remarks

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

projects/{project}/subscriptions/{subscription}

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

object.ToString()

TryParse(string, out SubscriptionName)

public static bool TryParse(string subscriptionName, out SubscriptionName result)

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

Parameters
Name	Description
`subscriptionName`	`string` The resource name in string form. Must not be `null`.
`result`	`SubscriptionName` When this method returns, the parsed SubscriptionName, 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}/subscriptions/{subscription}

TryParse(string, bool, out SubscriptionName)

public static bool TryParse(string subscriptionName, bool allowUnparsed, out SubscriptionName result)

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

Parameters
Name	Description
`subscriptionName`	`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`	`SubscriptionName` When this method returns, the parsed SubscriptionName, 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}/subscriptions/{subscription}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SubscriptionName, SubscriptionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`SubscriptionName` The first resource name to compare, or null.
`b`	`SubscriptionName` 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 !=(SubscriptionName, SubscriptionName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`SubscriptionName` The first resource name to compare, or null.
`b`	`SubscriptionName` 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.