Show / Hide Table of Contents

Class SubscriptionName

Resource name for the Subscription resource.

Inheritance
object
SubscriptionName
Implements
IResourceName
IEquatable<SubscriptionName>
Inherited Members
object.GetType()
Namespace: Google.Apps.Events.Subscriptions.V1
Assembly: Google.Apps.Events.Subscriptions.V1.dll
Syntax
public sealed class SubscriptionName : IResourceName, IEquatable<SubscriptionName>

Constructors

SubscriptionName(string)

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

Declaration
public SubscriptionName(string subscriptionId)
Parameters
Type Name Description
string subscriptionId

The Subscription 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
bool
Implements
IResourceName.IsKnownPattern

SubscriptionId

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

Declaration
public string SubscriptionId { get; }
Property Value
Type Description
string

Type

The SubscriptionName.ResourceNameType of the contained resource name.

Declaration
public SubscriptionName.ResourceNameType Type { get; }
Property Value
Type Description
SubscriptionName.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)

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

Declaration
public static string Format(string subscriptionId)
Parameters
Type Name Description
string subscriptionId

The Subscription ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this SubscriptionName with pattern subscriptions/{subscription}.

FormatSubscription(string)

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

Declaration
public static string FormatSubscription(string subscriptionId)
Parameters
Type Name Description
string subscriptionId

The Subscription ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this SubscriptionName with pattern subscriptions/{subscription}.

FromSubscription(string)

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

Declaration
public static SubscriptionName FromSubscription(string subscriptionId)
Parameters
Type Name Description
string subscriptionId

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)

Creates a SubscriptionName containing an unparsed resource name.

Declaration
public static SubscriptionName FromUnparsed(UnparsedResourceName unparsedResourceName)
Parameters
Type 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()

Returns a hash code for this resource name.

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
object.GetHashCode()

Parse(string)

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

Declaration
public static SubscriptionName Parse(string subscriptionName)
Parameters
Type Name Description
string subscriptionName

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:

  • subscriptions/{subscription}

Parse(string, bool)

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

Declaration
public static SubscriptionName Parse(string subscriptionName, bool allowUnparsed)
Parameters
Type Name Description
string subscriptionName

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

bool allowUnparsed

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:

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

The string representation of the resource name.

Overrides
object.ToString()
Implements
IResourceName.ToString()

TryParse(string, out SubscriptionName)

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

Declaration
public static bool TryParse(string subscriptionName, out SubscriptionName result)
Parameters
Type Name Description
string subscriptionName

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

SubscriptionName result

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:

  • subscriptions/{subscription}

TryParse(string, bool, out SubscriptionName)

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

Declaration
public static bool TryParse(string subscriptionName, bool allowUnparsed, out SubscriptionName result)
Parameters
Type Name Description
string subscriptionName

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

bool allowUnparsed

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.

SubscriptionName result

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:

  • subscriptions/{subscription}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(SubscriptionName, SubscriptionName)

Determines whether two specified resource names have the same value.

Declaration
public static bool operator ==(SubscriptionName a, SubscriptionName b)
Parameters
Type Name Description
SubscriptionName a

The first resource name to compare, or null.

SubscriptionName b

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)

Determines whether two specified resource names have different values.

Declaration
public static bool operator !=(SubscriptionName a, SubscriptionName b)
Parameters
Type Name Description
SubscriptionName a

The first resource name to compare, or null.

SubscriptionName b

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.

In this article
Back to top Generated by DocFX