Class FieldName

public sealed class FieldName : IResourceName, IEquatable<FieldName>

Resource name for the Field resource.

Inheritance

Object > FieldName

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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

databaseIdString

The Database ID. Must not be null or empty.

collectionIdString

The Collection ID. Must not be null or empty.

fieldIdString

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
TypeDescription
String

DatabaseId

public string DatabaseId { get; }

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

Property Value
TypeDescription
String

FieldId

public string FieldId { get; }

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

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

Type

public FieldName.ResourceNameType Type { get; }

The FieldName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
FieldName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

databaseIdString

The Database ID. Must not be null or empty.

collectionIdString

The Collection ID. Must not be null or empty.

fieldIdString

The Field ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

databaseIdString

The Database ID. Must not be null or empty.

collectionIdString

The Collection ID. Must not be null or empty.

fieldIdString

The Field ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

databaseIdString

The Database ID. Must not be null or empty.

collectionIdString

The Collection ID. Must not be null or empty.

fieldIdString

The Field ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
FieldName

A new instance of FieldName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static FieldName Parse(string fieldName)

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

Parameter
NameDescription
fieldNameString

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

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

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
NameDescription
fieldNameString

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

allowUnparsedBoolean

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
TypeDescription
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
TypeDescription
String

The string representation of the resource name.

Overrides

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
NameDescription
fieldNameString

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

resultFieldName

When this method returns, the parsed FieldName, or null if parsing failed.

Returns
TypeDescription
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}/databases/{database}/collectionGroups/{collection}/fields/{field}

TryParse(String, Boolean, 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
NameDescription
fieldNameString

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

allowUnparsedBoolean

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.

resultFieldName

When this method returns, the parsed FieldName, or null if parsing failed.

Returns
TypeDescription
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}/databases/{database}/collectionGroups/{collection}/fields/{field}
Or may be in any format if allowUnparsed is true.

Operators

Equality(FieldName, FieldName)

public static bool operator ==(FieldName a, FieldName b)
Parameters
NameDescription
aFieldName
bFieldName
Returns
TypeDescription
Boolean

Inequality(FieldName, FieldName)

public static bool operator !=(FieldName a, FieldName b)
Parameters
NameDescription
aFieldName
bFieldName
Returns
TypeDescription
Boolean