Cloud Composer v1 API - Class UserWorkloadsSecretName (2.5.0)

public sealed class UserWorkloadsSecretName : IResourceName, IEquatable<UserWorkloadsSecretName>

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

Resource name for the UserWorkloadsSecret resource.

Inheritance

object > UserWorkloadsSecretName

Namespace

Google.Cloud.Orchestration.Airflow.Service.V1

Assembly

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

Constructors

UserWorkloadsSecretName(string, string, string, string)

public UserWorkloadsSecretName(string projectId, string locationId, string environmentId, string userWorkloadsSecretId)

Constructs a new instance of a UserWorkloadsSecretName class from the component parts of pattern projects/{project}/locations/{location}/environments/{environment}/userWorkloadsSecrets/{user_workloads_secret}

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.

userWorkloadsSecretIdstring

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

The UserWorkloadsSecretName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
UserWorkloadsSecretNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

UserWorkloadsSecretId

public string UserWorkloadsSecretId { get; }

The UserWorkloadsSecret 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 userWorkloadsSecretId)

Formats the IDs into the string representation of this UserWorkloadsSecretName with pattern projects/{project}/locations/{location}/environments/{environment}/userWorkloadsSecrets/{user_workloads_secret} .

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.

userWorkloadsSecretIdstring

The UserWorkloadsSecret ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this UserWorkloadsSecretName with pattern projects/{project}/locations/{location}/environments/{environment}/userWorkloadsSecrets/{user_workloads_secret} .

FormatProjectLocationEnvironmentUserWorkloadsSecret(string, string, string, string)

public static string FormatProjectLocationEnvironmentUserWorkloadsSecret(string projectId, string locationId, string environmentId, string userWorkloadsSecretId)

Formats the IDs into the string representation of this UserWorkloadsSecretName with pattern projects/{project}/locations/{location}/environments/{environment}/userWorkloadsSecrets/{user_workloads_secret} .

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.

userWorkloadsSecretIdstring

The UserWorkloadsSecret ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this UserWorkloadsSecretName with pattern projects/{project}/locations/{location}/environments/{environment}/userWorkloadsSecrets/{user_workloads_secret} .

FromProjectLocationEnvironmentUserWorkloadsSecret(string, string, string, string)

public static UserWorkloadsSecretName FromProjectLocationEnvironmentUserWorkloadsSecret(string projectId, string locationId, string environmentId, string userWorkloadsSecretId)

Creates a UserWorkloadsSecretName with the pattern projects/{project}/locations/{location}/environments/{environment}/userWorkloadsSecrets/{user_workloads_secret} .

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.

userWorkloadsSecretIdstring

The UserWorkloadsSecret ID. Must not be null or empty.

Returns
TypeDescription
UserWorkloadsSecretName

A new instance of UserWorkloadsSecretName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static UserWorkloadsSecretName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a UserWorkloadsSecretName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
UserWorkloadsSecretName

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

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

Parameter
NameDescription
userWorkloadsSecretNamestring

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

Returns
TypeDescription
UserWorkloadsSecretName

The parsed UserWorkloadsSecretName if successful.

Remarks

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

  • projects/{project}/locations/{location}/environments/{environment}/userWorkloadsSecrets/{user_workloads_secret}

Parse(string, bool)

public static UserWorkloadsSecretName Parse(string userWorkloadsSecretName, bool allowUnparsed)

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

Parameters
NameDescription
userWorkloadsSecretNamestring

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
UserWorkloadsSecretName

The parsed UserWorkloadsSecretName if successful.

Remarks

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

  • projects/{project}/locations/{location}/environments/{environment}/userWorkloadsSecrets/{user_workloads_secret}
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 UserWorkloadsSecretName)

public static bool TryParse(string userWorkloadsSecretName, out UserWorkloadsSecretName result)

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

Parameters
NameDescription
userWorkloadsSecretNamestring

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

resultUserWorkloadsSecretName

When this method returns, the parsed UserWorkloadsSecretName, 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}/userWorkloadsSecrets/{user_workloads_secret}

TryParse(string, bool, out UserWorkloadsSecretName)

public static bool TryParse(string userWorkloadsSecretName, bool allowUnparsed, out UserWorkloadsSecretName result)

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

Parameters
NameDescription
userWorkloadsSecretNamestring

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.

resultUserWorkloadsSecretName

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

Operators

operator ==(UserWorkloadsSecretName, UserWorkloadsSecretName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aUserWorkloadsSecretName

The first resource name to compare, or null.

bUserWorkloadsSecretName

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

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aUserWorkloadsSecretName

The first resource name to compare, or null.

bUserWorkloadsSecretName

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.