Data Analytics API with Gemini v1beta API - Class DataAgentName (1.0.0-beta01) 

public sealed class DataAgentName : IResourceName, IEquatable<DataAgentName>

Reference documentation and code samples for the Data Analytics API with Gemini v1beta API class DataAgentName.

Resource name for the DataAgent resource.

Inheritance

object > DataAgentName

Namespace

Google.Cloud.GeminiDataAnalytics.V1Beta

Assembly

Google.Cloud.GeminiDataAnalytics.V1Beta.dll

Constructors

DataAgentName(string, string, string)

public DataAgentName(string projectId, string locationId, string dataAgentId)

Constructs a new instance of a DataAgentName class from the component parts of pattern projects/{project}/locations/{location}/dataAgents/{data_agent}

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

The DataAgent ID. Must not be null or empty.

Properties

DataAgentId

public string DataAgentId { get; }

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

The DataAgentName.ResourceNameType of the contained resource name.

Property Value
Type Description
DataAgentNameResourceNameType

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

Formats the IDs into the string representation of this DataAgentName with pattern projects/{project}/locations/{location}/dataAgents/{data_agent}.

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

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

The string representation of this DataAgentName with pattern projects/{project}/locations/{location}/dataAgents/{data_agent}.

FormatProjectLocationDataAgent(string, string, string)

public static string FormatProjectLocationDataAgent(string projectId, string locationId, string dataAgentId)

Formats the IDs into the string representation of this DataAgentName with pattern projects/{project}/locations/{location}/dataAgents/{data_agent}.

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

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

The string representation of this DataAgentName with pattern projects/{project}/locations/{location}/dataAgents/{data_agent}.

FromProjectLocationDataAgent(string, string, string)

public static DataAgentName FromProjectLocationDataAgent(string projectId, string locationId, string dataAgentId)

Creates a DataAgentName with the pattern projects/{project}/locations/{location}/dataAgents/{data_agent}.

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

The DataAgent ID. Must not be null or empty.
Returns
Type Description
DataAgentName

A new instance of DataAgentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DataAgentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DataAgentName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
dataAgentName string

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

The parsed DataAgentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dataAgents/{data_agent}

Parse(string, bool)

public static DataAgentName Parse(string dataAgentName, bool allowUnparsed)

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

Parameters
Name Description
dataAgentName 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
DataAgentName

The parsed DataAgentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dataAgents/{data_agent}
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 DataAgentName)

public static bool TryParse(string dataAgentName, out DataAgentName result)

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

Parameters
Name Description
dataAgentName string

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

When this method returns, the parsed DataAgentName, 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}/dataAgents/{data_agent}

TryParse(string, bool, out DataAgentName)

public static bool TryParse(string dataAgentName, bool allowUnparsed, out DataAgentName result)

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

Parameters
Name Description
dataAgentName 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 DataAgentName

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

Operators

operator ==(DataAgentName, DataAgentName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DataAgentName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DataAgentName

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

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.