Cloud Dataplex v1 API - Class AssetName (2.15.0)

public sealed class AssetName : IResourceName, IEquatable<AssetName>

Reference documentation and code samples for the Cloud Dataplex v1 API class AssetName.

Resource name for the Asset resource.

Inheritance

object > AssetName

Implements

IResourceName, IEquatable AssetName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

AssetName(string, string, string, string, string)

public AssetName(string projectId, string locationId, string lakeId, string zoneId, string assetId)

Constructs a new instance of a AssetName class from the component parts of pattern projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}

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.
`lakeId`	`string` The `Lake` ID. Must not be `null` or empty.
`zoneId`	`string` The `Zone` ID. Must not be `null` or empty.
`assetId`	`string` The `Asset` ID. Must not be `null` or empty.

Properties

AssetId

public string AssetId { get; }

The Asset 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`

LakeId

public string LakeId { get; }

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

Property Value
Type	Description
`string`

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

The AssetName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AssetNameResourceNameType`

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type	Description
`UnparsedResourceName`

ZoneId

public string ZoneId { get; }

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

Property Value
Type	Description
`string`

Methods

Format(string, string, string, string, string)

public static string Format(string projectId, string locationId, string lakeId, string zoneId, string assetId)

Formats the IDs into the string representation of this AssetName with pattern projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}.

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.
`lakeId`	`string` The `Lake` ID. Must not be `null` or empty.
`zoneId`	`string` The `Zone` ID. Must not be `null` or empty.
`assetId`	`string` The `Asset` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AssetName with pattern `projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}`.

FormatProjectLocationLakeZoneAsset(string, string, string, string, string)

public static string FormatProjectLocationLakeZoneAsset(string projectId, string locationId, string lakeId, string zoneId, string assetId)

Formats the IDs into the string representation of this AssetName with pattern projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}.

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.
`lakeId`	`string` The `Lake` ID. Must not be `null` or empty.
`zoneId`	`string` The `Zone` ID. Must not be `null` or empty.
`assetId`	`string` The `Asset` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AssetName with pattern `projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}`.

FromProjectLocationLakeZoneAsset(string, string, string, string, string)

public static AssetName FromProjectLocationLakeZoneAsset(string projectId, string locationId, string lakeId, string zoneId, string assetId)

Creates a AssetName with the pattern projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}.

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.
`lakeId`	`string` The `Lake` ID. Must not be `null` or empty.
`zoneId`	`string` The `Zone` ID. Must not be `null` or empty.
`assetId`	`string` The `Asset` ID. Must not be `null` or empty.

Returns
Type	Description
`AssetName`	A new instance of AssetName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AssetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AssetName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`AssetName`	A new instance of AssetName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static AssetName Parse(string assetName)

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

Parameter
Name	Description
`assetName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`AssetName`	The parsed AssetName if successful.

Remarks

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

projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}

Parse(string, bool)

public static AssetName Parse(string assetName, bool allowUnparsed)

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

Parameters
Name	Description
`assetName`	`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
`AssetName`	The parsed AssetName if successful.

Remarks

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

projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}

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

object.ToString()

TryParse(string, out AssetName)

public static bool TryParse(string assetName, out AssetName result)

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

Parameters
Name	Description
`assetName`	`string` The resource name in string form. Must not be `null`.
`result`	`AssetName` When this method returns, the parsed AssetName, 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}/lakes/{lake}/zones/{zone}/assets/{asset}

TryParse(string, bool, out AssetName)

public static bool TryParse(string assetName, bool allowUnparsed, out AssetName result)

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

Parameters
Name	Description
`assetName`	`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`	`AssetName` When this method returns, the parsed AssetName, 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}/lakes/{lake}/zones/{zone}/assets/{asset}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AssetName, AssetName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`AssetName` The first resource name to compare, or null.
`b`	`AssetName` 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 !=(AssetName, AssetName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`AssetName` The first resource name to compare, or null.
`b`	`AssetName` 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.