Cloud Dataplex v1 API - Class ActionName (2.11.0)

public sealed class ActionName : IResourceName, IEquatable<ActionName>

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

Resource name for the Action resource.

Inheritance

object > ActionName

Implements

IResourceName, IEquatable ActionName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

ActionName(string, string, string, string)

public ActionName(string projectId, string locationId, string lakeId, string actionId)

Constructs a new instance of a ActionName class from the component parts of pattern projects/{project}/locations/{location}/lakes/{lake}/actions/{action}

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.
`actionId`	`string` The `Action` ID. Must not be `null` or empty.

Properties

ActionId

public string ActionId { get; }

The Action ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

AssetId

public string AssetId { get; }

The Asset ID. May be null, depending on which resource name is contained by this instance.

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. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

LocationId

public string LocationId { get; }

The Location ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

Type

public ActionName.ResourceNameType Type { get; }

The ActionName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ActionNameResourceNameType`

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. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string lakeId, string actionId)

Formats the IDs into the string representation of this ActionName with pattern projects/{project}/locations/{location}/lakes/{lake}/actions/{action}.

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.
`actionId`	`string` The `Action` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ActionName with pattern `projects/{project}/locations/{location}/lakes/{lake}/actions/{action}`.

FormatProjectLocationLakeAction(string, string, string, string)

public static string FormatProjectLocationLakeAction(string projectId, string locationId, string lakeId, string actionId)

Formats the IDs into the string representation of this ActionName with pattern projects/{project}/locations/{location}/lakes/{lake}/actions/{action}.

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.
`actionId`	`string` The `Action` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ActionName with pattern `projects/{project}/locations/{location}/lakes/{lake}/actions/{action}`.

FormatProjectLocationLakeZoneAction(string, string, string, string, string)

public static string FormatProjectLocationLakeZoneAction(string projectId, string locationId, string lakeId, string zoneId, string actionId)

Formats the IDs into the string representation of this ActionName with pattern projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/actions/{action}.

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.
`actionId`	`string` The `Action` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ActionName with pattern `projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/actions/{action}`.

FormatProjectLocationLakeZoneAssetAction(string, string, string, string, string, string)

public static string FormatProjectLocationLakeZoneAssetAction(string projectId, string locationId, string lakeId, string zoneId, string assetId, string actionId)

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

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.
`actionId`	`string` The `Action` ID. Must not be `null` or empty.

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

FromProjectLocationLakeAction(string, string, string, string)

public static ActionName FromProjectLocationLakeAction(string projectId, string locationId, string lakeId, string actionId)

Creates a ActionName with the pattern projects/{project}/locations/{location}/lakes/{lake}/actions/{action}.

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.
`actionId`	`string` The `Action` ID. Must not be `null` or empty.

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

FromProjectLocationLakeZoneAction(string, string, string, string, string)

public static ActionName FromProjectLocationLakeZoneAction(string projectId, string locationId, string lakeId, string zoneId, string actionId)

Creates a ActionName with the pattern projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/actions/{action}.

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.
`actionId`	`string` The `Action` ID. Must not be `null` or empty.

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

FromProjectLocationLakeZoneAssetAction(string, string, string, string, string, string)

public static ActionName FromProjectLocationLakeZoneAssetAction(string projectId, string locationId, string lakeId, string zoneId, string assetId, string actionId)

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

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.
`actionId`	`string` The `Action` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static ActionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ActionName containing an unparsed resource name.

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

Returns
Type	Description
`ActionName`	A new instance of ActionName 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 ActionName Parse(string actionName)

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

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

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

Remarks

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

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

Parse(string, bool)

public static ActionName Parse(string actionName, bool allowUnparsed)

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

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

Remarks

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

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

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 ActionName)

public static bool TryParse(string actionName, out ActionName result)

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

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

TryParse(string, bool, out ActionName)

public static bool TryParse(string actionName, bool allowUnparsed, out ActionName result)

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

Parameters
Name	Description
`actionName`	`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`	`ActionName` When this method returns, the parsed ActionName, 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}/actions/{action}
projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/actions/{action}
projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}/actions/{action}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ActionName, ActionName)

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

Parameters
Name	Description
`a`	`ActionName`
`b`	`ActionName`

Returns
Type	Description
`bool`

operator !=(ActionName, ActionName)

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

Parameters
Name	Description
`a`	`ActionName`
`b`	`ActionName`

Returns
Type	Description
`bool`