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

Version 3.1.0

• 3.15.0 (latest)
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.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

Implements

IResourceName, IEquatable<ImportJobName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
Name	Description
projectId	String The Project ID. Must not be null or empty.
locationId	String The Location ID. Must not be null or empty.
keyRingId	String The KeyRing 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
Boolean

KeyRingId

public string KeyRingId { get; }

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

Property Value
Type	Description
String

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
ImportJobName.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, 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
Name	Description
projectId	String The Project ID. Must not be null or empty.
locationId	String The Location ID. Must not be null or empty.
keyRingId	String The KeyRing 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}/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
Name	Description
projectId	String The Project ID. Must not be null or empty.
locationId	String The Location ID. Must not be null or empty.
keyRingId	String The KeyRing 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}/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
Name	Description
projectId	String The Project ID. Must not be null or empty.
locationId	String The Location ID. Must not be null or empty.
keyRingId	String The KeyRing 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
Int32

Overrides

Object.GetHashCode()

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}/keyRings/{key_ring}/importJobs/{import_job}

Parse(String, Boolean)

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	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
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
Type	Description
String	The string representation of the resource name.

Overrides

Object.ToString()

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
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}/locations/{location}/keyRings/{key_ring}/importJobs/{import_job}

TryParse(String, Boolean, 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	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	ImportJobName When this method returns, the parsed ImportJobName, 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}/locations/{location}/keyRings/{key_ring}/importJobs/{import_job}

Or may be in any format if allowUnparsed is true.

Operators

Equality(ImportJobName, ImportJobName)

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

Parameters
Name	Description
a	ImportJobName
b	ImportJobName

Returns
Type	Description
Boolean

Inequality(ImportJobName, ImportJobName)

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

Parameters
Name	Description
a	ImportJobName
b	ImportJobName

Returns
Type	Description
Boolean