Struct DatasetDescriptor

A struct containing the identifiers for a dataset.

Inherited Members
Namespace: Unity.Cloud.Common
Assembly: Unity.Cloud.Common.dll
Syntax
public readonly struct DatasetDescriptor

Constructors

DatasetDescriptor(AssetDescriptor, DatasetId)

Creates an instance of the DatasetDescriptor struct.

Declaration
public DatasetDescriptor(AssetDescriptor assetDescriptor, DatasetId datasetId)
Parameters
Type Name Description
AssetDescriptor assetDescriptor

The dataset's asset descriptor.
DatasetId datasetId

The dataset's ID.

Fields

AssetDescriptor

The dataset's asset descriptor.

Declaration
public readonly AssetDescriptor AssetDescriptor
Field Value
Type Description
AssetDescriptor

DatasetId

The dataset's ID.

Declaration
public readonly DatasetId DatasetId
Field Value
Type Description
DatasetId

Properties

AssetId

The asset's ID.

Declaration
public AssetId AssetId { get; }
Property Value
Type Description
AssetId

AssetVersion

The asset's version.

Declaration
public AssetVersion AssetVersion { get; }
Property Value
Type Description
AssetVersion

OrganizationId

The project's organization ID.

Declaration
public OrganizationId OrganizationId { get; }
Property Value
Type Description
OrganizationId

ProjectId

The project's ID.

Declaration
public ProjectId ProjectId { get; }
Property Value
Type Description
ProjectId

Methods

Equals(object)

Validate obj is a DatasetDescriptor instance and have the same values as this instance.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj

Compare the values with this instance.
Returns
Type Description
bool

true if both instance have the same values; false otherwise.
Overrides

Equals(DatasetDescriptor)

Returns whether two DatasetDescriptor objects are equals.

Declaration
public bool Equals(DatasetDescriptor other)
Parameters
Type Name Description
DatasetDescriptor other

Compare the values with this instance.
Returns
Type Description
bool

true if both instance have the same values; false otherwise.

FromJson(string)

Deserializes the given JSON string into a DatasetDescriptor object.

Declaration
public static DatasetDescriptor FromJson(string json)
Parameters
Type Name Description
string json

A DatasetDescriptor serialized as a JSON string.
Returns
Type Description
DatasetDescriptor

A DatasetDescriptor.

GetHashCode()

Compute a hash code for the object.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.
Overrides
Remarks
  • You should not assume that equal hash codes imply object equality.
  • You should never persist or use a hash code outside the application domain in which it was created, because the same object may hash differently across application domains, processes, and platforms.

ToJson()

Serializes the DatasetDescriptor into a JSON string.

Declaration
public string ToJson()
Returns
Type Description
string

A DatasetDescriptor serialized as a JSON string.

Operators

operator ==(DatasetDescriptor, DatasetDescriptor)

Checks whether two DatasetDescriptor are equal.

Declaration
public static bool operator ==(DatasetDescriptor left, DatasetDescriptor right)
Parameters
Type Name Description
DatasetDescriptor left

Compare with this first instance.
DatasetDescriptor right

Compare with this other instance.
Returns
Type Description
bool

true if both instances represent the same; false otherwise.

operator !=(DatasetDescriptor, DatasetDescriptor)

Checks whether two DatasetDescriptor aren't equal.

Declaration
public static bool operator !=(DatasetDescriptor left, DatasetDescriptor right)
Parameters
Type Name Description
DatasetDescriptor left

Compare with this first instance.
DatasetDescriptor right

Compare with this other instance.
Returns
Type Description
bool

true if both instances are not the same; false if both instances are the same.