Class SchemaName (2.7.0)

public sealed class SchemaName : IResourceName, IEquatable<SchemaName>

Resource name for the Schema resource.

Inheritance

Object > SchemaName

Implements

IResourceName, IEquatable<SchemaName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
`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`

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
`SchemaName.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 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
`Int32`

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

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`	`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
`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
`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}/schemas/{schema}

TryParse(String, Boolean, 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`	`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`	`SchemaName` When this method returns, the parsed SchemaName, 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}/schemas/{schema}

Or may be in any format if allowUnparsed is true.

Operators

Equality(SchemaName, SchemaName)

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

Parameters
Name	Description
`a`	`SchemaName`
`b`	`SchemaName`

Returns
Type	Description
`Boolean`

Inequality(SchemaName, SchemaName)

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

Parameters
Name	Description
`a`	`SchemaName`
`b`	`SchemaName`

Returns
Type	Description
`Boolean`