Google Cloud Dataproc v1 API - Class AutoscalingPolicyName (5.1.0)

public sealed class AutoscalingPolicyName : IResourceName, IEquatable<AutoscalingPolicyName>

Reference documentation and code samples for the Google Cloud Dataproc v1 API class AutoscalingPolicyName.

Resource name for the AutoscalingPolicy resource.

Inheritance

Object > AutoscalingPolicyName

Namespace

Google.Cloud.Dataproc.V1

Assembly

Google.Cloud.Dataproc.V1.dll

Constructors

AutoscalingPolicyName(String, String, String)

public AutoscalingPolicyName(string projectId, string locationId, string autoscalingPolicyId)

Constructs a new instance of a AutoscalingPolicyName class from the component parts of pattern projects/{project}/locations/{location}/autoscalingPolicies/{autoscaling_policy}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

autoscalingPolicyIdString

The AutoscalingPolicy ID. Must not be null or empty.

Properties

AutoscalingPolicyId

public string AutoscalingPolicyId { get; }

The AutoscalingPolicy ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

LocationId

public string LocationId { get; }

The Location ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
String

RegionId

public string RegionId { get; }

The Region ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
String

Type

public AutoscalingPolicyName.ResourceNameType Type { get; }

The AutoscalingPolicyName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
AutoscalingPolicyName.ResourceNameType

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)

public static string Format(string projectId, string locationId, string autoscalingPolicyId)

Formats the IDs into the string representation of this AutoscalingPolicyName with pattern projects/{project}/locations/{location}/autoscalingPolicies/{autoscaling_policy}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

autoscalingPolicyIdString

The AutoscalingPolicy ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this AutoscalingPolicyName with pattern projects/{project}/locations/{location}/autoscalingPolicies/{autoscaling_policy}.

FormatProjectLocationAutoscalingPolicy(String, String, String)

public static string FormatProjectLocationAutoscalingPolicy(string projectId, string locationId, string autoscalingPolicyId)

Formats the IDs into the string representation of this AutoscalingPolicyName with pattern projects/{project}/locations/{location}/autoscalingPolicies/{autoscaling_policy}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

autoscalingPolicyIdString

The AutoscalingPolicy ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this AutoscalingPolicyName with pattern projects/{project}/locations/{location}/autoscalingPolicies/{autoscaling_policy}.

FormatProjectRegionAutoscalingPolicy(String, String, String)

public static string FormatProjectRegionAutoscalingPolicy(string projectId, string regionId, string autoscalingPolicyId)

Formats the IDs into the string representation of this AutoscalingPolicyName with pattern projects/{project}/regions/{region}/autoscalingPolicies/{autoscaling_policy}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

regionIdString

The Region ID. Must not be null or empty.

autoscalingPolicyIdString

The AutoscalingPolicy ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this AutoscalingPolicyName with pattern projects/{project}/regions/{region}/autoscalingPolicies/{autoscaling_policy}.

FromProjectLocationAutoscalingPolicy(String, String, String)

public static AutoscalingPolicyName FromProjectLocationAutoscalingPolicy(string projectId, string locationId, string autoscalingPolicyId)

Creates a AutoscalingPolicyName with the pattern projects/{project}/locations/{location}/autoscalingPolicies/{autoscaling_policy}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

autoscalingPolicyIdString

The AutoscalingPolicy ID. Must not be null or empty.

Returns
TypeDescription
AutoscalingPolicyName

A new instance of AutoscalingPolicyName constructed from the provided ids.

FromProjectRegionAutoscalingPolicy(String, String, String)

public static AutoscalingPolicyName FromProjectRegionAutoscalingPolicy(string projectId, string regionId, string autoscalingPolicyId)

Creates a AutoscalingPolicyName with the pattern projects/{project}/regions/{region}/autoscalingPolicies/{autoscaling_policy}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

regionIdString

The Region ID. Must not be null or empty.

autoscalingPolicyIdString

The AutoscalingPolicy ID. Must not be null or empty.

Returns
TypeDescription
AutoscalingPolicyName

A new instance of AutoscalingPolicyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AutoscalingPolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AutoscalingPolicyName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
AutoscalingPolicyName

A new instance of AutoscalingPolicyName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static AutoscalingPolicyName Parse(string autoscalingPolicyName)

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

Parameter
NameDescription
autoscalingPolicyNameString

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

Returns
TypeDescription
AutoscalingPolicyName

The parsed AutoscalingPolicyName if successful.

Remarks

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

  • projects/{project}/locations/{location}/autoscalingPolicies/{autoscaling_policy}
  • projects/{project}/regions/{region}/autoscalingPolicies/{autoscaling_policy}

Parse(String, Boolean)

public static AutoscalingPolicyName Parse(string autoscalingPolicyName, bool allowUnparsed)

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

Parameters
NameDescription
autoscalingPolicyNameString

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

allowUnparsedBoolean

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
AutoscalingPolicyName

The parsed AutoscalingPolicyName if successful.

Remarks

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

  • projects/{project}/locations/{location}/autoscalingPolicies/{autoscaling_policy}
  • projects/{project}/regions/{region}/autoscalingPolicies/{autoscaling_policy}
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 AutoscalingPolicyName)

public static bool TryParse(string autoscalingPolicyName, out AutoscalingPolicyName result)

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

Parameters
NameDescription
autoscalingPolicyNameString

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

resultAutoscalingPolicyName

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

Returns
TypeDescription
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}/autoscalingPolicies/{autoscaling_policy}
  • projects/{project}/regions/{region}/autoscalingPolicies/{autoscaling_policy}

TryParse(String, Boolean, out AutoscalingPolicyName)

public static bool TryParse(string autoscalingPolicyName, bool allowUnparsed, out AutoscalingPolicyName result)

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

Parameters
NameDescription
autoscalingPolicyNameString

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

allowUnparsedBoolean

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.

resultAutoscalingPolicyName

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

Returns
TypeDescription
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}/autoscalingPolicies/{autoscaling_policy}
  • projects/{project}/regions/{region}/autoscalingPolicies/{autoscaling_policy}
Or may be in any format if allowUnparsed is true.

Operators

Equality(AutoscalingPolicyName, AutoscalingPolicyName)

public static bool operator ==(AutoscalingPolicyName a, AutoscalingPolicyName b)
Parameters
NameDescription
aAutoscalingPolicyName
bAutoscalingPolicyName
Returns
TypeDescription
Boolean

Inequality(AutoscalingPolicyName, AutoscalingPolicyName)

public static bool operator !=(AutoscalingPolicyName a, AutoscalingPolicyName b)
Parameters
NameDescription
aAutoscalingPolicyName
bAutoscalingPolicyName
Returns
TypeDescription
Boolean