Analytics Hub v1 API - Class RoutineName (1.8.0) 

public sealed class RoutineName : IResourceName, IEquatable<RoutineName>

Reference documentation and code samples for the Analytics Hub v1 API class RoutineName.

Resource name for the Routine resource.

Inheritance

object > RoutineName

Namespace

Google.Cloud.BigQuery.AnalyticsHub.V1

Assembly

Google.Cloud.BigQuery.AnalyticsHub.V1.dll

Constructors

RoutineName(string, string, string)

public RoutineName(string projectId, string datasetId, string routineId)

Constructs a new instance of a RoutineName class from the component parts of pattern projects/{project}/datasets/{dataset}/routines/{routine}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
datasetId string

The Dataset ID. Must not be null or empty.
routineId string

The Routine ID. Must not be null or empty.

Properties

DatasetId

public string DatasetId { get; }

The Dataset 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

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

RoutineId

public string RoutineId { get; }

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

Property Value
Type Description
string

Type

public RoutineName.ResourceNameType Type { get; }

The RoutineName.ResourceNameType of the contained resource name.

Property Value
Type Description
RoutineNameResourceNameType

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 datasetId, string routineId)

Formats the IDs into the string representation of this RoutineName with pattern projects/{project}/datasets/{dataset}/routines/{routine}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
datasetId string

The Dataset ID. Must not be null or empty.
routineId string

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

The string representation of this RoutineName with pattern projects/{project}/datasets/{dataset}/routines/{routine}.

FormatProjectDatasetRoutine(string, string, string)

public static string FormatProjectDatasetRoutine(string projectId, string datasetId, string routineId)

Formats the IDs into the string representation of this RoutineName with pattern projects/{project}/datasets/{dataset}/routines/{routine}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
datasetId string

The Dataset ID. Must not be null or empty.
routineId string

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

The string representation of this RoutineName with pattern projects/{project}/datasets/{dataset}/routines/{routine}.

FromProjectDatasetRoutine(string, string, string)

public static RoutineName FromProjectDatasetRoutine(string projectId, string datasetId, string routineId)

Creates a RoutineName with the pattern projects/{project}/datasets/{dataset}/routines/{routine}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
datasetId string

The Dataset ID. Must not be null or empty.
routineId string

The Routine ID. Must not be null or empty.
Returns
Type Description
RoutineName

A new instance of RoutineName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RoutineName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RoutineName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
routineName string

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

The parsed RoutineName if successful.
Remarks

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

  • projects/{project}/datasets/{dataset}/routines/{routine}

Parse(string, bool)

public static RoutineName Parse(string routineName, bool allowUnparsed)

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

Parameters
Name Description
routineName 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
RoutineName

The parsed RoutineName if successful.
Remarks

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

  • projects/{project}/datasets/{dataset}/routines/{routine}
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 RoutineName)

public static bool TryParse(string routineName, out RoutineName result)

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

Parameters
Name Description
routineName string

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

When this method returns, the parsed RoutineName, 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}/datasets/{dataset}/routines/{routine}

TryParse(string, bool, out RoutineName)

public static bool TryParse(string routineName, bool allowUnparsed, out RoutineName result)

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

Parameters
Name Description
routineName 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 RoutineName

When this method returns, the parsed RoutineName, 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}/datasets/{dataset}/routines/{routine}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(RoutineName, RoutineName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RoutineName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RoutineName

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

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.