Cloud AI Platform v1 API - Class BatchPredictionJobName (3.7.0) 

public sealed class BatchPredictionJobName : IResourceName, IEquatable<BatchPredictionJobName>

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

Resource name for the BatchPredictionJob resource.

Inheritance

object > BatchPredictionJobName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

BatchPredictionJobName(string, string, string)

public BatchPredictionJobName(string projectId, string locationId, string batchPredictionJobId)

Constructs a new instance of a BatchPredictionJobName class from the component parts of pattern projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}

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

The BatchPredictionJob ID. Must not be null or empty.

Properties

BatchPredictionJobId

public string BatchPredictionJobId { get; }

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

The BatchPredictionJobName.ResourceNameType of the contained resource name.

Property Value
Type Description
BatchPredictionJobNameResourceNameType

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

Formats the IDs into the string representation of this BatchPredictionJobName with pattern projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}.

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

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

The string representation of this BatchPredictionJobName with pattern projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}.

FormatProjectLocationBatchPredictionJob(string, string, string)

public static string FormatProjectLocationBatchPredictionJob(string projectId, string locationId, string batchPredictionJobId)

Formats the IDs into the string representation of this BatchPredictionJobName with pattern projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}.

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

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

The string representation of this BatchPredictionJobName with pattern projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}.

FromProjectLocationBatchPredictionJob(string, string, string)

public static BatchPredictionJobName FromProjectLocationBatchPredictionJob(string projectId, string locationId, string batchPredictionJobId)

Creates a BatchPredictionJobName with the pattern projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}.

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

The BatchPredictionJob ID. Must not be null or empty.
Returns
Type Description
BatchPredictionJobName

A new instance of BatchPredictionJobName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static BatchPredictionJobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BatchPredictionJobName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
batchPredictionJobName string

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

The parsed BatchPredictionJobName if successful.
Remarks

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

  • projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}

Parse(string, bool)

public static BatchPredictionJobName Parse(string batchPredictionJobName, bool allowUnparsed)

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

Parameters
Name Description
batchPredictionJobName 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
BatchPredictionJobName

The parsed BatchPredictionJobName if successful.
Remarks

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

  • projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}
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 BatchPredictionJobName)

public static bool TryParse(string batchPredictionJobName, out BatchPredictionJobName result)

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

Parameters
Name Description
batchPredictionJobName string

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

When this method returns, the parsed BatchPredictionJobName, 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}/batchPredictionJobs/{batch_prediction_job}

TryParse(string, bool, out BatchPredictionJobName)

public static bool TryParse(string batchPredictionJobName, bool allowUnparsed, out BatchPredictionJobName result)

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

Parameters
Name Description
batchPredictionJobName 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 BatchPredictionJobName

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

Operators

operator ==(BatchPredictionJobName, BatchPredictionJobName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a BatchPredictionJobName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a BatchPredictionJobName

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

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.