Discovery Engine v1 API - Class FhirResourceName (1.10.0) 

public sealed class FhirResourceName : IResourceName, IEquatable<FhirResourceName>

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

Resource name for the FhirResource resource.

Inheritance

object > FhirResourceName

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

FhirResourceName(string, string, string, string, string, string)

public FhirResourceName(string projectId, string locationId, string datasetId, string fhirStoreId, string resourceTypeId, string fhirResourceId)

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

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.
resourceTypeId string

The ResourceType ID. Must not be null or empty.
fhirResourceId string

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

FhirResourceId

public string FhirResourceId { get; }

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

ResourceTypeId

public string ResourceTypeId { get; }

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

Property Value
Type Description
string

Type

public FhirResourceName.ResourceNameType Type { get; }

The FhirResourceName.ResourceNameType of the contained resource name.

Property Value
Type Description
FhirResourceNameResourceNameType

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

public static string Format(string projectId, string locationId, string datasetId, string fhirStoreId, string resourceTypeId, string fhirResourceId)

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

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.
resourceTypeId string

The ResourceType ID. Must not be null or empty.
fhirResourceId string

The FhirResource ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this FhirResourceName with pattern projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} .

FormatProjectLocationDatasetFhirStoreResourceTypeFhirResource(string, string, string, string, string, string)

public static string FormatProjectLocationDatasetFhirStoreResourceTypeFhirResource(string projectId, string locationId, string datasetId, string fhirStoreId, string resourceTypeId, string fhirResourceId)

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

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.
resourceTypeId string

The ResourceType ID. Must not be null or empty.
fhirResourceId string

The FhirResource ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this FhirResourceName with pattern projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} .

FromProjectLocationDatasetFhirStoreResourceTypeFhirResource(string, string, string, string, string, string)

public static FhirResourceName FromProjectLocationDatasetFhirStoreResourceTypeFhirResource(string projectId, string locationId, string datasetId, string fhirStoreId, string resourceTypeId, string fhirResourceId)

Creates a FhirResourceName with the pattern projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} .

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.
resourceTypeId string

The ResourceType ID. Must not be null or empty.
fhirResourceId string

The FhirResource ID. Must not be null or empty.
Returns
Type Description
FhirResourceName

A new instance of FhirResourceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FhirResourceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FhirResourceName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
FhirResourceName

A new instance of FhirResourceName 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 FhirResourceName Parse(string fhirResourceName)

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

Parameter
Name Description
fhirResourceName string

The resource name in string form. Must not be null.
Returns
Type Description
FhirResourceName

The parsed FhirResourceName 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}/fhir/{resource_type}/{fhir_resource_id}

Parse(string, bool)

public static FhirResourceName Parse(string fhirResourceName, bool allowUnparsed)

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

Parameters
Name Description
fhirResourceName 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
FhirResourceName

The parsed FhirResourceName 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}/fhir/{resource_type}/{fhir_resource_id}
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 FhirResourceName)

public static bool TryParse(string fhirResourceName, out FhirResourceName result)

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

Parameters
Name Description
fhirResourceName string

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

When this method returns, the parsed FhirResourceName, 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}/fhir/{resource_type}/{fhir_resource_id}

TryParse(string, bool, out FhirResourceName)

public static bool TryParse(string fhirResourceName, bool allowUnparsed, out FhirResourceName result)

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

Parameters
Name Description
fhirResourceName 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 FhirResourceName

When this method returns, the parsed FhirResourceName, 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}/fhir/{resource_type}/{fhir_resource_id}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(FhirResourceName, FhirResourceName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a FhirResourceName

The first resource name to compare, or null.
b FhirResourceName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a FhirResourceName

The first resource name to compare, or null.
b FhirResourceName

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.