Cloud Composer v1 API - Class UserWorkloadsConfigMapName (2.5.0)

public sealed class UserWorkloadsConfigMapName : IResourceName, IEquatable<UserWorkloadsConfigMapName>

Reference documentation and code samples for the Cloud Composer v1 API class UserWorkloadsConfigMapName.

Resource name for the UserWorkloadsConfigMap resource.

Inheritance

object > UserWorkloadsConfigMapName

Namespace

Google.Cloud.Orchestration.Airflow.Service.V1

Assembly

Google.Cloud.Orchestration.Airflow.Service.V1.dll

Constructors

UserWorkloadsConfigMapName(string, string, string, string)

public UserWorkloadsConfigMapName(string projectId, string locationId, string environmentId, string userWorkloadsConfigMapId)

Constructs a new instance of a UserWorkloadsConfigMapName class from the component parts of pattern projects/{project}/locations/{location}/environments/{environment}/userWorkloadsConfigMaps/{user_workloads_config_map}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

environmentIdstring

The Environment ID. Must not be null or empty.

userWorkloadsConfigMapIdstring

The UserWorkloadsConfigMap ID. Must not be null or empty.

Properties

EnvironmentId

public string EnvironmentId { get; }

The Environment 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

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

The UserWorkloadsConfigMapName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
UserWorkloadsConfigMapNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

UserWorkloadsConfigMapId

public string UserWorkloadsConfigMapId { get; }

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

Property Value
TypeDescription
string

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string environmentId, string userWorkloadsConfigMapId)

Formats the IDs into the string representation of this UserWorkloadsConfigMapName with pattern

projects/{project}/locations/{location}/environments/{environment}/userWorkloadsConfigMaps/{user_workloads_config_map} .

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

environmentIdstring

The Environment ID. Must not be null or empty.

userWorkloadsConfigMapIdstring

The UserWorkloadsConfigMap ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this UserWorkloadsConfigMapName with pattern projects/{project}/locations/{location}/environments/{environment}/userWorkloadsConfigMaps/{user_workloads_config_map} .

FormatProjectLocationEnvironmentUserWorkloadsConfigMap(string, string, string, string)

public static string FormatProjectLocationEnvironmentUserWorkloadsConfigMap(string projectId, string locationId, string environmentId, string userWorkloadsConfigMapId)

Formats the IDs into the string representation of this UserWorkloadsConfigMapName with pattern

projects/{project}/locations/{location}/environments/{environment}/userWorkloadsConfigMaps/{user_workloads_config_map} .

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

environmentIdstring

The Environment ID. Must not be null or empty.

userWorkloadsConfigMapIdstring

The UserWorkloadsConfigMap ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this UserWorkloadsConfigMapName with pattern projects/{project}/locations/{location}/environments/{environment}/userWorkloadsConfigMaps/{user_workloads_config_map} .

FromProjectLocationEnvironmentUserWorkloadsConfigMap(string, string, string, string)

public static UserWorkloadsConfigMapName FromProjectLocationEnvironmentUserWorkloadsConfigMap(string projectId, string locationId, string environmentId, string userWorkloadsConfigMapId)

Creates a UserWorkloadsConfigMapName with the pattern projects/{project}/locations/{location}/environments/{environment}/userWorkloadsConfigMaps/{user_workloads_config_map} .

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

environmentIdstring

The Environment ID. Must not be null or empty.

userWorkloadsConfigMapIdstring

The UserWorkloadsConfigMap ID. Must not be null or empty.

Returns
TypeDescription
UserWorkloadsConfigMapName

A new instance of UserWorkloadsConfigMapName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static UserWorkloadsConfigMapName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a UserWorkloadsConfigMapName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
UserWorkloadsConfigMapName

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

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

Parameter
NameDescription
userWorkloadsConfigMapNamestring

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

Returns
TypeDescription
UserWorkloadsConfigMapName

The parsed UserWorkloadsConfigMapName if successful.

Remarks

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

  • projects/{project}/locations/{location}/environments/{environment}/userWorkloadsConfigMaps/{user_workloads_config_map}

Parse(string, bool)

public static UserWorkloadsConfigMapName Parse(string userWorkloadsConfigMapName, bool allowUnparsed)

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

Parameters
NameDescription
userWorkloadsConfigMapNamestring

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
UserWorkloadsConfigMapName

The parsed UserWorkloadsConfigMapName if successful.

Remarks

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

  • projects/{project}/locations/{location}/environments/{environment}/userWorkloadsConfigMaps/{user_workloads_config_map}
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 UserWorkloadsConfigMapName)

public static bool TryParse(string userWorkloadsConfigMapName, out UserWorkloadsConfigMapName result)

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

Parameters
NameDescription
userWorkloadsConfigMapNamestring

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

resultUserWorkloadsConfigMapName

When this method returns, the parsed UserWorkloadsConfigMapName, 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}/environments/{environment}/userWorkloadsConfigMaps/{user_workloads_config_map}

TryParse(string, bool, out UserWorkloadsConfigMapName)

public static bool TryParse(string userWorkloadsConfigMapName, bool allowUnparsed, out UserWorkloadsConfigMapName result)

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

Parameters
NameDescription
userWorkloadsConfigMapNamestring

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.

resultUserWorkloadsConfigMapName

When this method returns, the parsed UserWorkloadsConfigMapName, 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}/environments/{environment}/userWorkloadsConfigMaps/{user_workloads_config_map}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(UserWorkloadsConfigMapName, UserWorkloadsConfigMapName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aUserWorkloadsConfigMapName

The first resource name to compare, or null.

bUserWorkloadsConfigMapName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(UserWorkloadsConfigMapName, UserWorkloadsConfigMapName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aUserWorkloadsConfigMapName

The first resource name to compare, or null.

bUserWorkloadsConfigMapName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.