Class SubscriptionName (3.1.0)

Version 3.1.0

• 3.19.0 (latest)
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.1
• 3.9.1
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.1
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0

public sealed class SubscriptionName : IResourceName, IEquatable<SubscriptionName>

Resource name for the Subscription resource.

Inheritance

Object > SubscriptionName

Implements

IResourceName, IEquatable<SubscriptionName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
Boolean

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
SubscriptionName.ResourceNameType

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
Int32

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, Boolean)

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	Boolean 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
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}/subscriptions/{subscription}

TryParse(String, Boolean, 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	Boolean 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
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}/subscriptions/{subscription}

Or may be in any format if allowUnparsed is true.

Operators

Equality(SubscriptionName, SubscriptionName)

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

Parameters
Name	Description
a	SubscriptionName
b	SubscriptionName

Returns
Type	Description
Boolean

Inequality(SubscriptionName, SubscriptionName)

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

Parameters
Name	Description
a	SubscriptionName
b	SubscriptionName

Returns
Type	Description
Boolean