Discovery Engine v1 API - Class FhirStoreName (1.4.0)

public sealed class FhirStoreName : IResourceName, IEquatable<FhirStoreName>

Reference documentation and code samples for the Discovery Engine v1 API class FhirStoreName.

Resource name for the FhirStore resource.

Inheritance

object > FhirStoreName

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

FhirStoreName(string, string, string, string)

public FhirStoreName(string projectId, string locationId, string datasetId, string fhirStoreId)

Constructs a new instance of a FhirStoreName class from the component parts of pattern projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

datasetId string

The Dataset ID. Must not be null or empty.

fhirStoreId string

The FhirStore ID. Must not be null or empty.

Properties

DatasetId

public string DatasetId { get; }

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

Property Value
Type Description
string

FhirStoreId

public string FhirStoreId { get; }

The FhirStore 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

LocationId

public string LocationId { get; }

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

Property Value
Type Description
string

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 FhirStoreName.ResourceNameType Type { get; }

The FhirStoreName.ResourceNameType of the contained resource name.

Property Value
Type Description
FhirStoreNameResourceNameType

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 locationId, string datasetId, string fhirStoreId)

Formats the IDs into the string representation of this FhirStoreName with pattern projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

datasetId string

The Dataset ID. Must not be null or empty.

fhirStoreId string

The FhirStore ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this FhirStoreName with pattern projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}.

FormatProjectLocationDatasetFhirStore(string, string, string, string)

public static string FormatProjectLocationDatasetFhirStore(string projectId, string locationId, string datasetId, string fhirStoreId)

Formats the IDs into the string representation of this FhirStoreName with pattern projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

datasetId string

The Dataset ID. Must not be null or empty.

fhirStoreId string

The FhirStore ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this FhirStoreName with pattern projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}.

FromProjectLocationDatasetFhirStore(string, string, string, string)

public static FhirStoreName FromProjectLocationDatasetFhirStore(string projectId, string locationId, string datasetId, string fhirStoreId)

Creates a FhirStoreName with the pattern projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

datasetId string

The Dataset ID. Must not be null or empty.

fhirStoreId string

The FhirStore ID. Must not be null or empty.

Returns
Type Description
FhirStoreName

A new instance of FhirStoreName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FhirStoreName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FhirStoreName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
FhirStoreName

A new instance of FhirStoreName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static FhirStoreName Parse(string fhirStoreName)

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

Parameter
Name Description
fhirStoreName string

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

Returns
Type Description
FhirStoreName

The parsed FhirStoreName if successful.

Remarks

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

  • projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}

Parse(string, bool)

public static FhirStoreName Parse(string fhirStoreName, bool allowUnparsed)

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

Parameters
Name Description
fhirStoreName 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
FhirStoreName

The parsed FhirStoreName if successful.

Remarks

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

  • projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}
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

TryParse(string, out FhirStoreName)

public static bool TryParse(string fhirStoreName, out FhirStoreName result)

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

Parameters
Name Description
fhirStoreName string

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

result FhirStoreName

When this method returns, the parsed FhirStoreName, 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}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}

TryParse(string, bool, out FhirStoreName)

public static bool TryParse(string fhirStoreName, bool allowUnparsed, out FhirStoreName result)

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

Parameters
Name Description
fhirStoreName 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 FhirStoreName

When this method returns, the parsed FhirStoreName, 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}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(FhirStoreName, FhirStoreName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a FhirStoreName

The first resource name to compare, or null.

b FhirStoreName

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 !=(FhirStoreName, FhirStoreName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a FhirStoreName

The first resource name to compare, or null.

b FhirStoreName

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.