Cloud AI Platform v1 API - Class ScheduleName (3.13.0)

Version latest

• 3.13.0 (latest)
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class ScheduleName : IResourceName, IEquatable<ScheduleName>

Reference documentation and code samples for the Cloud AI Platform v1 API class ScheduleName.

Resource name for the Schedule resource.

Inheritance

object > ScheduleName

Implements

IResourceName, IEquatableScheduleName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

ScheduleName(string, string, string)

public ScheduleName(string projectId, string locationId, string scheduleId)

Constructs a new instance of a ScheduleName class from the component parts of pattern projects/{project}/locations/{location}/schedules/{schedule}

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.
scheduleId	string The Schedule ID. Must not be null or empty.

Properties

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

ScheduleId

public string ScheduleId { get; }

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

Property Value
Type	Description
string

Type

public ScheduleName.ResourceNameType Type { get; }

The ScheduleName.ResourceNameType of the contained resource name.

Property Value
Type	Description
ScheduleNameResourceNameType

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

Formats the IDs into the string representation of this ScheduleName with pattern projects/{project}/locations/{location}/schedules/{schedule}.

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.
scheduleId	string The Schedule ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ScheduleName with pattern projects/{project}/locations/{location}/schedules/{schedule}.

FormatProjectLocationSchedule(string, string, string)

public static string FormatProjectLocationSchedule(string projectId, string locationId, string scheduleId)

Formats the IDs into the string representation of this ScheduleName with pattern projects/{project}/locations/{location}/schedules/{schedule}.

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.
scheduleId	string The Schedule ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ScheduleName with pattern projects/{project}/locations/{location}/schedules/{schedule}.

FromProjectLocationSchedule(string, string, string)

public static ScheduleName FromProjectLocationSchedule(string projectId, string locationId, string scheduleId)

Creates a ScheduleName with the pattern projects/{project}/locations/{location}/schedules/{schedule}.

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.
scheduleId	string The Schedule ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static ScheduleName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ScheduleName containing an unparsed resource name.

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

Returns
Type	Description
ScheduleName	A new instance of ScheduleName 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 ScheduleName Parse(string scheduleName)

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

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

Returns
Type	Description
ScheduleName	The parsed ScheduleName if successful.

Remarks

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

• projects/{project}/locations/{location}/schedules/{schedule}

Parse(string, bool)

public static ScheduleName Parse(string scheduleName, bool allowUnparsed)

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

Parameters
Name	Description
scheduleName	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
ScheduleName	The parsed ScheduleName if successful.

Remarks

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

• projects/{project}/locations/{location}/schedules/{schedule}

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

public static bool TryParse(string scheduleName, out ScheduleName result)

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

Parameters
Name	Description
scheduleName	string The resource name in string form. Must not be null.
result	ScheduleName When this method returns, the parsed ScheduleName, 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}/schedules/{schedule}

TryParse(string, bool, out ScheduleName)

public static bool TryParse(string scheduleName, bool allowUnparsed, out ScheduleName result)

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

Parameters
Name	Description
scheduleName	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	ScheduleName When this method returns, the parsed ScheduleName, 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}/schedules/{schedule}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ScheduleName, ScheduleName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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