Google Cloud Key Management Service v1 API - Class ImportJobName (3.5.0)

public sealed class ImportJobName : IResourceName, IEquatable<ImportJobName>

Reference documentation and code samples for the Google Cloud Key Management Service v1 API class ImportJobName.

Resource name for the ImportJob resource.

Inheritance

object > ImportJobName

Namespace

Google.Cloud.Kms.V1

Assembly

Google.Cloud.Kms.V1.dll

Constructors

ImportJobName(string, string, string, string)

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

Constructs a new instance of a ImportJobName class from the component parts of pattern projects/{project}/locations/{location}/keyRings/{key_ring}/importJobs/{import_job}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

keyRingIdstring

The KeyRing ID. Must not be null or empty.

importJobIdstring

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
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
bool

KeyRingId

public string KeyRingId { get; }

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

Property Value
TypeDescription
string

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

Type

public ImportJobName.ResourceNameType Type { get; }

The ImportJobName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ImportJobNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string, string, string)

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

Formats the IDs into the string representation of this ImportJobName with pattern projects/{project}/locations/{location}/keyRings/{key_ring}/importJobs/{import_job}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

keyRingIdstring

The KeyRing ID. Must not be null or empty.

importJobIdstring

The ImportJob ID. Must not be null or empty.

Returns
TypeDescription
string

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

FormatProjectLocationKeyRingImportJob(string, string, string, string)

public static string FormatProjectLocationKeyRingImportJob(string projectId, string locationId, string keyRingId, string importJobId)

Formats the IDs into the string representation of this ImportJobName with pattern projects/{project}/locations/{location}/keyRings/{key_ring}/importJobs/{import_job}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

keyRingIdstring

The KeyRing ID. Must not be null or empty.

importJobIdstring

The ImportJob ID. Must not be null or empty.

Returns
TypeDescription
string

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

FromProjectLocationKeyRingImportJob(string, string, string, string)

public static ImportJobName FromProjectLocationKeyRingImportJob(string projectId, string locationId, string keyRingId, string importJobId)

Creates a ImportJobName with the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/importJobs/{import_job}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

keyRingIdstring

The KeyRing ID. Must not be null or empty.

importJobIdstring

The ImportJob ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ImportJobName

A new instance of ImportJobName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static ImportJobName Parse(string importJobName)

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

Parameter
NameDescription
importJobNamestring

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

Returns
TypeDescription
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}/keyRings/{key_ring}/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
NameDescription
importJobNamestring

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

allowUnparsedbool

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
TypeDescription
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}/keyRings/{key_ring}/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
TypeDescription
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
NameDescription
importJobNamestring

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

resultImportJobName

When this method returns, the parsed ImportJobName, or null if parsing failed.

Returns
TypeDescription
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}/keyRings/{key_ring}/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
NameDescription
importJobNamestring

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

allowUnparsedbool

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.

resultImportJobName

When this method returns, the parsed ImportJobName, or null if parsing failed.

Returns
TypeDescription
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}/keyRings/{key_ring}/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)
Parameters
NameDescription
aImportJobName
bImportJobName
Returns
TypeDescription
bool

operator !=(ImportJobName, ImportJobName)

public static bool operator !=(ImportJobName a, ImportJobName b)
Parameters
NameDescription
aImportJobName
bImportJobName
Returns
TypeDescription
bool