AI Platform Notebooks v1 API - Class ScheduleName (2.1.0)

public sealed class ScheduleName : IResourceName, IEquatable<ScheduleName>

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

Resource name for the Schedule resource.

Inheritance

Object > ScheduleName

Implements

IResourceName, IEquatable<ScheduleName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Notebooks.V1

Assembly

Google.Cloud.Notebooks.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}/location/{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
`Boolean`

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
`ScheduleName.ResourceNameType`

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}/location/{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}/location/{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}/location/{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}/location/{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}/location/{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
`Int32`

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}/location/{location}/schedules/{schedule}

Parse(String, Boolean)

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`	`Boolean` 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}/location/{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
`Boolean`	`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}/location/{location}/schedules/{schedule}

TryParse(String, Boolean, 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`	`Boolean` 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
`Boolean`	`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}/location/{location}/schedules/{schedule}

Or may be in any format if allowUnparsed is true.

Operators

Equality(ScheduleName, ScheduleName)

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

Parameters
Name	Description
`a`	`ScheduleName`
`b`	`ScheduleName`

Returns
Type	Description
`Boolean`

Inequality(ScheduleName, ScheduleName)

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

Parameters
Name	Description
`a`	`ScheduleName`
`b`	`ScheduleName`

Returns
Type	Description
`Boolean`