Cloud Pub/Sub v1 API - Class SchemaName (3.7.0)

Version 3.7.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 SchemaName : IResourceName, IEquatable<SchemaName>

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

Resource name for the Schema resource.

Inheritance

object > SchemaName

Implements

IResourceName, IEquatableSchemaName

Inherited Members

object.GetType()

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Constructors

SchemaName(string, string)

public SchemaName(string projectId, string schemaId)

Constructs a new instance of a SchemaName class from the component parts of pattern projects/{project}/schemas/{schema}

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
schemaId	string The Schema 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

SchemaId

public string SchemaId { get; }

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

Property Value
Type	Description
string

Type

public SchemaName.ResourceNameType Type { get; }

The SchemaName.ResourceNameType of the contained resource name.

Property Value
Type	Description
SchemaNameResourceNameType

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

Formats the IDs into the string representation of this SchemaName with pattern projects/{project}/schemas/{schema}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
schemaId	string The Schema ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this SchemaName with pattern projects/{project}/schemas/{schema}.

FormatProjectSchema(string, string)

public static string FormatProjectSchema(string projectId, string schemaId)

Formats the IDs into the string representation of this SchemaName with pattern projects/{project}/schemas/{schema}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
schemaId	string The Schema ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this SchemaName with pattern projects/{project}/schemas/{schema}.

FromProjectSchema(string, string)

public static SchemaName FromProjectSchema(string projectId, string schemaId)

Creates a SchemaName with the pattern projects/{project}/schemas/{schema}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
schemaId	string The Schema ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static SchemaName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SchemaName containing an unparsed resource name.

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

Returns
Type	Description
SchemaName	A new instance of SchemaName 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 SchemaName Parse(string schemaName)

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

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

Returns
Type	Description
SchemaName	The parsed SchemaName if successful.

Remarks

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

• projects/{project}/schemas/{schema}

Parse(string, bool)

public static SchemaName Parse(string schemaName, bool allowUnparsed)

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

Parameters
Name	Description
schemaName	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
SchemaName	The parsed SchemaName if successful.

Remarks

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

• projects/{project}/schemas/{schema}

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

public static bool TryParse(string schemaName, out SchemaName result)

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

Parameters
Name	Description
schemaName	string The resource name in string form. Must not be null.
result	SchemaName When this method returns, the parsed SchemaName, 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}/schemas/{schema}

TryParse(string, bool, out SchemaName)

public static bool TryParse(string schemaName, bool allowUnparsed, out SchemaName result)

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

Parameters
Name	Description
schemaName	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	SchemaName When this method returns, the parsed SchemaName, 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}/schemas/{schema}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SchemaName, SchemaName)

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

Parameters
Name	Description
a	SchemaName
b	SchemaName

Returns
Type	Description
bool

operator !=(SchemaName, SchemaName)

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

Parameters
Name	Description
a	SchemaName
b	SchemaName

Returns
Type	Description
bool