Migration Center v1 API - Class ImportDataFileName (1.4.0) 

public sealed class ImportDataFileName : IResourceName, IEquatable<ImportDataFileName>

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

Resource name for the ImportDataFile resource.

Inheritance

object > ImportDataFileName

Namespace

Google.Cloud.MigrationCenter.V1

Assembly

Google.Cloud.MigrationCenter.V1.dll

Constructors

ImportDataFileName(string, string, string, string)

public ImportDataFileName(string projectId, string locationId, string importJobId, string importDataFileId)

Constructs a new instance of a ImportDataFileName class from the component parts of pattern projects/{project}/locations/{location}/importJobs/{import_job}/importDataFiles/{import_data_file}

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

The ImportDataFile ID. Must not be null or empty.

Properties

ImportDataFileId

public string ImportDataFileId { get; }

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

Property Value
Type Description
string

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 ImportDataFileName.ResourceNameType Type { get; }

The ImportDataFileName.ResourceNameType of the contained resource name.

Property Value
Type Description
ImportDataFileNameResourceNameType

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

public static string Format(string projectId, string locationId, string importJobId, string importDataFileId)

Formats the IDs into the string representation of this ImportDataFileName with pattern projects/{project}/locations/{location}/importJobs/{import_job}/importDataFiles/{import_data_file}.

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

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

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

FormatProjectLocationImportJobImportDataFile(string, string, string, string)

public static string FormatProjectLocationImportJobImportDataFile(string projectId, string locationId, string importJobId, string importDataFileId)

Formats the IDs into the string representation of this ImportDataFileName with pattern projects/{project}/locations/{location}/importJobs/{import_job}/importDataFiles/{import_data_file}.

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

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

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

FromProjectLocationImportJobImportDataFile(string, string, string, string)

public static ImportDataFileName FromProjectLocationImportJobImportDataFile(string projectId, string locationId, string importJobId, string importDataFileId)

Creates a ImportDataFileName with the pattern projects/{project}/locations/{location}/importJobs/{import_job}/importDataFiles/{import_data_file}.

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

The ImportDataFile ID. Must not be null or empty.
Returns
Type Description
ImportDataFileName

A new instance of ImportDataFileName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ImportDataFileName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ImportDataFileName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
importDataFileName string

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

The parsed ImportDataFileName if successful.
Remarks

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

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

Parse(string, bool)

public static ImportDataFileName Parse(string importDataFileName, bool allowUnparsed)

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

Parameters
Name Description
importDataFileName 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
ImportDataFileName

The parsed ImportDataFileName if successful.
Remarks

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

  • projects/{project}/locations/{location}/importJobs/{import_job}/importDataFiles/{import_data_file}
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 ImportDataFileName)

public static bool TryParse(string importDataFileName, out ImportDataFileName result)

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

Parameters
Name Description
importDataFileName string

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

When this method returns, the parsed ImportDataFileName, 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}/importDataFiles/{import_data_file}

TryParse(string, bool, out ImportDataFileName)

public static bool TryParse(string importDataFileName, bool allowUnparsed, out ImportDataFileName result)

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

Parameters
Name Description
importDataFileName 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 ImportDataFileName

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

Operators

operator ==(ImportDataFileName, ImportDataFileName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ImportDataFileName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ImportDataFileName

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

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.