public sealed class TaskName : IResourceName, IEquatable<TaskName>
Reference documentation and code samples for the Cloud Dataplex v1 API class TaskName.
Resource name for the Task
resource.
Namespace
Google.Cloud.Dataplex.V1Assembly
Google.Cloud.Dataplex.V1.dll
Constructors
TaskName(string, string, string, string)
public TaskName(string projectId, string locationId, string lakeId, string taskId)
Constructs a new instance of a TaskName class from the component parts of pattern
projects/{project}/locations/{location}/lakes/{lake}/tasks/{task}
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
lakeId | string The |
taskId | string The |
Properties
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 |
TaskId
public string TaskId { get; }
The Task
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
Type
public TaskName.ResourceNameType Type { get; }
The TaskName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
TaskNameResourceNameType |
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)
public static string Format(string projectId, string locationId, string lakeId, string taskId)
Formats the IDs into the string representation of this TaskName with pattern
projects/{project}/locations/{location}/lakes/{lake}/tasks/{task}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
lakeId | string The |
taskId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this TaskName with pattern
|
FormatProjectLocationLakeTask(string, string, string, string)
public static string FormatProjectLocationLakeTask(string projectId, string locationId, string lakeId, string taskId)
Formats the IDs into the string representation of this TaskName with pattern
projects/{project}/locations/{location}/lakes/{lake}/tasks/{task}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
lakeId | string The |
taskId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this TaskName with pattern
|
FromProjectLocationLakeTask(string, string, string, string)
public static TaskName FromProjectLocationLakeTask(string projectId, string locationId, string lakeId, string taskId)
Creates a TaskName with the pattern
projects/{project}/locations/{location}/lakes/{lake}/tasks/{task}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
lakeId | string The |
taskId | string The |
Returns | |
---|---|
Type | Description |
TaskName | A new instance of TaskName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static TaskName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a TaskName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName | UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
TaskName | A new instance of TaskName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static TaskName Parse(string taskName)
Parses the given resource name string into a new TaskName instance.
Parameter | |
---|---|
Name | Description |
taskName | string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
TaskName | The parsed TaskName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/lakes/{lake}/tasks/{task}
Parse(string, bool)
public static TaskName Parse(string taskName, bool allowUnparsed)
Parses the given resource name string into a new TaskName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
taskName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
TaskName | The parsed TaskName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/lakes/{lake}/tasks/{task}
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. |
TryParse(string, out TaskName)
public static bool TryParse(string taskName, out TaskName result)
Tries to parse the given resource name string into a new TaskName instance.
Parameters | |
---|---|
Name | Description |
taskName | string The resource name in string form. Must not be |
result | TaskName When this method returns, the parsed TaskName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/lakes/{lake}/tasks/{task}
TryParse(string, bool, out TaskName)
public static bool TryParse(string taskName, bool allowUnparsed, out TaskName result)
Tries to parse the given resource name string into a new TaskName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
taskName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
result | TaskName When this method returns, the parsed TaskName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/lakes/{lake}/tasks/{task}
allowUnparsed
is true
.
Operators
operator ==(TaskName, TaskName)
public static bool operator ==(TaskName a, TaskName b)
Parameters | |
---|---|
Name | Description |
a | TaskName |
b | TaskName |
Returns | |
---|---|
Type | Description |
bool |
operator !=(TaskName, TaskName)
public static bool operator !=(TaskName a, TaskName b)
Parameters | |
---|---|
Name | Description |
a | TaskName |
b | TaskName |
Returns | |
---|---|
Type | Description |
bool |