Google Cloud Storage Insights v1 API - Class DatasetConfigName (1.5.0) 

public sealed class DatasetConfigName : IResourceName, IEquatable<DatasetConfigName>

Reference documentation and code samples for the Google Cloud Storage Insights v1 API class DatasetConfigName.

Resource name for the DatasetConfig resource.

Inheritance

object > DatasetConfigName

Namespace

Google.Cloud.StorageInsights.V1

Assembly

Google.Cloud.StorageInsights.V1.dll

Constructors

DatasetConfigName(string, string, string)

public DatasetConfigName(string projectId, string locationId, string datasetConfigId)

Constructs a new instance of a DatasetConfigName class from the component parts of pattern projects/{project}/locations/{location}/datasetConfigs/{dataset_config}

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

The DatasetConfig ID. Must not be null or empty.

Properties

DatasetConfigId

public string DatasetConfigId { get; }

The DatasetConfig 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 DatasetConfigName.ResourceNameType Type { get; }

The DatasetConfigName.ResourceNameType of the contained resource name.

Property Value
Type Description
DatasetConfigNameResourceNameType

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)

public static string Format(string projectId, string locationId, string datasetConfigId)

Formats the IDs into the string representation of this DatasetConfigName with pattern projects/{project}/locations/{location}/datasetConfigs/{dataset_config}.

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

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

The string representation of this DatasetConfigName with pattern projects/{project}/locations/{location}/datasetConfigs/{dataset_config}.

FormatProjectLocationDatasetConfig(string, string, string)

public static string FormatProjectLocationDatasetConfig(string projectId, string locationId, string datasetConfigId)

Formats the IDs into the string representation of this DatasetConfigName with pattern projects/{project}/locations/{location}/datasetConfigs/{dataset_config}.

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

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

The string representation of this DatasetConfigName with pattern projects/{project}/locations/{location}/datasetConfigs/{dataset_config}.

FromProjectLocationDatasetConfig(string, string, string)

public static DatasetConfigName FromProjectLocationDatasetConfig(string projectId, string locationId, string datasetConfigId)

Creates a DatasetConfigName with the pattern projects/{project}/locations/{location}/datasetConfigs/{dataset_config}.

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

The DatasetConfig ID. Must not be null or empty.
Returns
Type Description
DatasetConfigName

A new instance of DatasetConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DatasetConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DatasetConfigName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
datasetConfigName string

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

The parsed DatasetConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/datasetConfigs/{dataset_config}

Parse(string, bool)

public static DatasetConfigName Parse(string datasetConfigName, bool allowUnparsed)

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

Parameters
Name Description
datasetConfigName 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
DatasetConfigName

The parsed DatasetConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/datasetConfigs/{dataset_config}
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 DatasetConfigName)

public static bool TryParse(string datasetConfigName, out DatasetConfigName result)

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

Parameters
Name Description
datasetConfigName string

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

When this method returns, the parsed DatasetConfigName, 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}/datasetConfigs/{dataset_config}

TryParse(string, bool, out DatasetConfigName)

public static bool TryParse(string datasetConfigName, bool allowUnparsed, out DatasetConfigName result)

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

Parameters
Name Description
datasetConfigName 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 DatasetConfigName

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

Operators

operator ==(DatasetConfigName, DatasetConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DatasetConfigName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DatasetConfigName

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

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.