Migration Center v1 API - Class ImportJobName (1.3.0)

public sealed class ImportJobName : IResourceName, IEquatable<ImportJobName>

Reference documentation and code samples for the Migration Center v1 API class ImportJobName.

Resource name for the ImportJob resource.

Inheritance

object > ImportJobName

Namespace

Google.Cloud.MigrationCenter.V1

Assembly

Google.Cloud.MigrationCenter.V1.dll

Constructors

ImportJobName(string, string, string)

public ImportJobName(string projectId, string locationId, string importJobId)

Constructs a new instance of a ImportJobName class from the component parts of pattern projects/{project}/locations/{location}/importJobs/{import_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.

importJobId string

The ImportJob ID. Must not be null or empty.

Properties

ImportJobId

public string ImportJobId { get; }

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

The ImportJobName.ResourceNameType of the contained resource name.

Property Value
Type Description
ImportJobNameResourceNameType

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

Formats the IDs into the string representation of this ImportJobName with pattern projects/{project}/locations/{location}/importJobs/{import_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.

importJobId string

The ImportJob ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ImportJobName with pattern projects/{project}/locations/{location}/importJobs/{import_job}.

FormatProjectLocationImportJob(string, string, string)

public static string FormatProjectLocationImportJob(string projectId, string locationId, string importJobId)

Formats the IDs into the string representation of this ImportJobName with pattern projects/{project}/locations/{location}/importJobs/{import_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.

importJobId string

The ImportJob ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ImportJobName with pattern projects/{project}/locations/{location}/importJobs/{import_job}.

FromProjectLocationImportJob(string, string, string)

public static ImportJobName FromProjectLocationImportJob(string projectId, string locationId, string importJobId)

Creates a ImportJobName with the pattern projects/{project}/locations/{location}/importJobs/{import_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.

importJobId string

The ImportJob ID. Must not be null or empty.

Returns
Type Description
ImportJobName

A new instance of ImportJobName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ImportJobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ImportJobName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
ImportJobName

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

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

Parameter
Name Description
importJobName string

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

Returns
Type Description
ImportJobName

The parsed ImportJobName if successful.

Remarks

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

  • projects/{project}/locations/{location}/importJobs/{import_job}

Parse(string, bool)

public static ImportJobName Parse(string importJobName, bool allowUnparsed)

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

Parameters
Name Description
importJobName 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
ImportJobName

The parsed ImportJobName if successful.

Remarks

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

  • projects/{project}/locations/{location}/importJobs/{import_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 ImportJobName)

public static bool TryParse(string importJobName, out ImportJobName result)

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

Parameters
Name Description
importJobName string

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

result ImportJobName

When this method returns, the parsed ImportJobName, 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}/importJobs/{import_job}

TryParse(string, bool, out ImportJobName)

public static bool TryParse(string importJobName, bool allowUnparsed, out ImportJobName result)

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

Parameters
Name Description
importJobName 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 ImportJobName

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

Operators

operator ==(ImportJobName, ImportJobName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ImportJobName

The first resource name to compare, or null.

b ImportJobName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ImportJobName

The first resource name to compare, or null.

b ImportJobName

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.