Google Cloud Dataproc v1 API - Class AutoscalingPolicyName (5.16.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

Implements

IResourceName, IEquatable AutoscalingPolicyName

Inherited Members

object.GetType()

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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`autoscalingPolicyId`	`string` 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
Type	Description
`string`

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type	Description
`bool`

LocationId

public string LocationId { get; }

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

Property Value
Type	Description
`string`

ProjectId

public string ProjectId { get; }

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

Property Value
Type	Description
`string`

RegionId

public string RegionId { get; }

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

Property Value
Type	Description
`string`

Type

public AutoscalingPolicyName.ResourceNameType Type { get; }

The AutoscalingPolicyName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AutoscalingPolicyNameResourceNameType`

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)

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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`autoscalingPolicyId`	`string` The `AutoscalingPolicy` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`autoscalingPolicyId`	`string` The `AutoscalingPolicy` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`regionId`	`string` The `Region` ID. Must not be `null` or empty.
`autoscalingPolicyId`	`string` The `AutoscalingPolicy` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`autoscalingPolicyId`	`string` The `AutoscalingPolicy` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`regionId`	`string` The `Region` ID. Must not be `null` or empty.
`autoscalingPolicyId`	`string` The `AutoscalingPolicy` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`AutoscalingPolicyName`	A new instance of AutoscalingPolicyName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static AutoscalingPolicyName Parse(string autoscalingPolicyName)

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

Parameter
Name	Description
`autoscalingPolicyName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`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, bool)

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
Name	Description
`autoscalingPolicyName`	`string` The resource name in string form. Must not be `null`.
`allowUnparsed`	`bool` 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
`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
Type	Description
`string`	The string representation of the resource name.

Overrides

object.ToString()

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
Name	Description
`autoscalingPolicyName`	`string` The resource name in string form. Must not be `null`.
`result`	`AutoscalingPolicyName` When this method returns, the parsed AutoscalingPolicyName, or `null` if parsing failed.

Returns
Type	Description
`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}/autoscalingPolicies/{autoscaling_policy}
projects/{project}/regions/{region}/autoscalingPolicies/{autoscaling_policy}

TryParse(string, bool, 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
Name	Description
`autoscalingPolicyName`	`string` The resource name in string form. Must not be `null`.
`allowUnparsed`	`bool` 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`	`AutoscalingPolicyName` When this method returns, the parsed AutoscalingPolicyName, or `null` if parsing failed.

Returns
Type	Description
`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}/autoscalingPolicies/{autoscaling_policy}
projects/{project}/regions/{region}/autoscalingPolicies/{autoscaling_policy}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AutoscalingPolicyName, AutoscalingPolicyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`AutoscalingPolicyName` The first resource name to compare, or null.
`b`	`AutoscalingPolicyName` The second resource name to compare, or null.

Returns
Type	Description
`bool`	true if the value of `a` is the same as the value of `b`; otherwise, false.

operator !=(AutoscalingPolicyName, AutoscalingPolicyName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`AutoscalingPolicyName` The first resource name to compare, or null.
`b`	`AutoscalingPolicyName` The second resource name to compare, or null.

Returns
Type	Description
`bool`	true if the value of `a` is different from the value of `b`; otherwise, false.