Capacity Planner v1beta API - Class ForecastName (1.0.0-beta01) 

public sealed class ForecastName : IResourceName, IEquatable<ForecastName>

Reference documentation and code samples for the Capacity Planner v1beta API class ForecastName.

Resource name for the Forecast resource.

Inheritance

object > ForecastName

Namespace

Google.Cloud.CapacityPlanner.V1Beta

Assembly

Google.Cloud.CapacityPlanner.V1Beta.dll

Constructors

ForecastName(string, string, string)

public ForecastName(string projectId, string locationId, string forecastId)

Constructs a new instance of a ForecastName class from the component parts of pattern projects/{project}/locations/{location}/forecasts/{forecast}

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.
forecastId string

The Forecast ID. Must not be null or empty.

Properties

FolderId

public string FolderId { get; }

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

Property Value
Type Description
string

ForecastId

public string ForecastId { get; }

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

OrganizationId

public string OrganizationId { get; }

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

Type

public ForecastName.ResourceNameType Type { get; }

The ForecastName.ResourceNameType of the contained resource name.

Property Value
Type Description
ForecastNameResourceNameType

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 forecastId)

Formats the IDs into the string representation of this ForecastName with pattern projects/{project}/locations/{location}/forecasts/{forecast}.

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.
forecastId string

The Forecast ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ForecastName with pattern projects/{project}/locations/{location}/forecasts/{forecast}.

FormatFolderLocationForecast(string, string, string)

public static string FormatFolderLocationForecast(string folderId, string locationId, string forecastId)

Formats the IDs into the string representation of this ForecastName with pattern folders/{folder}/locations/{location}/forecasts/{forecast}.

Parameters
Name Description
folderId string

The Folder ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
forecastId string

The Forecast ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ForecastName with pattern folders/{folder}/locations/{location}/forecasts/{forecast}.

FormatOrganizationLocationForecast(string, string, string)

public static string FormatOrganizationLocationForecast(string organizationId, string locationId, string forecastId)

Formats the IDs into the string representation of this ForecastName with pattern organizations/{organization}/locations/{location}/forecasts/{forecast}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
forecastId string

The Forecast ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ForecastName with pattern organizations/{organization}/locations/{location}/forecasts/{forecast}.

FormatProjectLocationForecast(string, string, string)

public static string FormatProjectLocationForecast(string projectId, string locationId, string forecastId)

Formats the IDs into the string representation of this ForecastName with pattern projects/{project}/locations/{location}/forecasts/{forecast}.

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.
forecastId string

The Forecast ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ForecastName with pattern projects/{project}/locations/{location}/forecasts/{forecast}.

FromFolderLocationForecast(string, string, string)

public static ForecastName FromFolderLocationForecast(string folderId, string locationId, string forecastId)

Creates a ForecastName with the pattern folders/{folder}/locations/{location}/forecasts/{forecast}.

Parameters
Name Description
folderId string

The Folder ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
forecastId string

The Forecast ID. Must not be null or empty.
Returns
Type Description
ForecastName

A new instance of ForecastName constructed from the provided ids.

FromOrganizationLocationForecast(string, string, string)

public static ForecastName FromOrganizationLocationForecast(string organizationId, string locationId, string forecastId)

Creates a ForecastName with the pattern organizations/{organization}/locations/{location}/forecasts/{forecast}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
forecastId string

The Forecast ID. Must not be null or empty.
Returns
Type Description
ForecastName

A new instance of ForecastName constructed from the provided ids.

FromProjectLocationForecast(string, string, string)

public static ForecastName FromProjectLocationForecast(string projectId, string locationId, string forecastId)

Creates a ForecastName with the pattern projects/{project}/locations/{location}/forecasts/{forecast}.

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.
forecastId string

The Forecast ID. Must not be null or empty.
Returns
Type Description
ForecastName

A new instance of ForecastName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ForecastName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ForecastName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
ForecastName

A new instance of ForecastName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static ForecastName Parse(string forecastName)

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

Parameter
Name Description
forecastName string

The resource name in string form. Must not be null.
Returns
Type Description
ForecastName

The parsed ForecastName if successful.
Remarks

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

  • projects/{project}/locations/{location}/forecasts/{forecast}
  • organizations/{organization}/locations/{location}/forecasts/{forecast}
  • folders/{folder}/locations/{location}/forecasts/{forecast}

Parse(string, bool)

public static ForecastName Parse(string forecastName, bool allowUnparsed)

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

Parameters
Name Description
forecastName 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
ForecastName

The parsed ForecastName if successful.
Remarks

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

  • projects/{project}/locations/{location}/forecasts/{forecast}
  • organizations/{organization}/locations/{location}/forecasts/{forecast}
  • folders/{folder}/locations/{location}/forecasts/{forecast}
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

TryParse(string, out ForecastName)

public static bool TryParse(string forecastName, out ForecastName result)

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

Parameters
Name Description
forecastName string

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

When this method returns, the parsed ForecastName, 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}/forecasts/{forecast}
  • organizations/{organization}/locations/{location}/forecasts/{forecast}
  • folders/{folder}/locations/{location}/forecasts/{forecast}

TryParse(string, bool, out ForecastName)

public static bool TryParse(string forecastName, bool allowUnparsed, out ForecastName result)

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

Parameters
Name Description
forecastName 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 ForecastName

When this method returns, the parsed ForecastName, 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}/forecasts/{forecast}
  • organizations/{organization}/locations/{location}/forecasts/{forecast}
  • folders/{folder}/locations/{location}/forecasts/{forecast}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ForecastName, ForecastName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ForecastName

The first resource name to compare, or null.
b ForecastName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ForecastName

The first resource name to compare, or null.
b ForecastName

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.