Firestore Admin v1 API - Class FieldName (3.4.0)

public sealed class FieldName : IResourceName, IEquatable<FieldName>

Reference documentation and code samples for the Firestore Admin v1 API class FieldName.

Resource name for the Field resource.

Inheritance

object > FieldName

Implements

IResourceName, IEquatable FieldName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

FieldName(string, string, string, string)

public FieldName(string projectId, string databaseId, string collectionId, string fieldId)

Constructs a new instance of a FieldName class from the component parts of pattern projects/{project}/databases/{database}/collectionGroups/{collection}/fields/{field}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`databaseId`	`string` The `Database` ID. Must not be `null` or empty.
`collectionId`	`string` The `Collection` ID. Must not be `null` or empty.
`fieldId`	`string` The `Field` ID. Must not be `null` or empty.

Properties

CollectionId

public string CollectionId { get; }

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

Property Value
Type	Description
`string`

DatabaseId

public string DatabaseId { get; }

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

Property Value
Type	Description
`string`

FieldId

public string FieldId { get; }

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

Property Value
Type	Description
`string`

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`

Type

public FieldName.ResourceNameType Type { get; }

The FieldName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`FieldNameResourceNameType`

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

public static string Format(string projectId, string databaseId, string collectionId, string fieldId)

Formats the IDs into the string representation of this FieldName with pattern projects/{project}/databases/{database}/collectionGroups/{collection}/fields/{field}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`databaseId`	`string` The `Database` ID. Must not be `null` or empty.
`collectionId`	`string` The `Collection` ID. Must not be `null` or empty.
`fieldId`	`string` The `Field` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this FieldName with pattern `projects/{project}/databases/{database}/collectionGroups/{collection}/fields/{field}`.

FormatProjectDatabaseCollectionField(string, string, string, string)

public static string FormatProjectDatabaseCollectionField(string projectId, string databaseId, string collectionId, string fieldId)

Formats the IDs into the string representation of this FieldName with pattern projects/{project}/databases/{database}/collectionGroups/{collection}/fields/{field}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`databaseId`	`string` The `Database` ID. Must not be `null` or empty.
`collectionId`	`string` The `Collection` ID. Must not be `null` or empty.
`fieldId`	`string` The `Field` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this FieldName with pattern `projects/{project}/databases/{database}/collectionGroups/{collection}/fields/{field}`.

FromProjectDatabaseCollectionField(string, string, string, string)

public static FieldName FromProjectDatabaseCollectionField(string projectId, string databaseId, string collectionId, string fieldId)

Creates a FieldName with the pattern projects/{project}/databases/{database}/collectionGroups/{collection}/fields/{field}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`databaseId`	`string` The `Database` ID. Must not be `null` or empty.
`collectionId`	`string` The `Collection` ID. Must not be `null` or empty.
`fieldId`	`string` The `Field` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static FieldName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FieldName containing an unparsed resource name.

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

Returns
Type	Description
`FieldName`	A new instance of FieldName 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 FieldName Parse(string fieldName)

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

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

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

Remarks

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

projects/{project}/databases/{database}/collectionGroups/{collection}/fields/{field}

Parse(string, bool)

public static FieldName Parse(string fieldName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/databases/{database}/collectionGroups/{collection}/fields/{field}

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

public static bool TryParse(string fieldName, out FieldName result)

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

Parameters
Name	Description
`fieldName`	`string` The resource name in string form. Must not be `null`.
`result`	`FieldName` When this method returns, the parsed FieldName, 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}/databases/{database}/collectionGroups/{collection}/fields/{field}

TryParse(string, bool, out FieldName)

public static bool TryParse(string fieldName, bool allowUnparsed, out FieldName result)

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

Parameters
Name	Description
`fieldName`	`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`	`FieldName` When this method returns, the parsed FieldName, 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}/databases/{database}/collectionGroups/{collection}/fields/{field}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(FieldName, FieldName)

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

Parameters
Name	Description
`a`	`FieldName`
`b`	`FieldName`

Returns
Type	Description
`bool`

operator !=(FieldName, FieldName)

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

Parameters
Name	Description
`a`	`FieldName`
`b`	`FieldName`

Returns
Type	Description
`bool`