Cloud Security Compliance v1 API - Class FrameworkDeploymentName (1.0.0-beta02) 

public sealed class FrameworkDeploymentName : IResourceName, IEquatable<FrameworkDeploymentName>

Reference documentation and code samples for the Cloud Security Compliance v1 API class FrameworkDeploymentName.

Resource name for the FrameworkDeployment resource.

Inheritance

object > FrameworkDeploymentName

Namespace

Google.Cloud.CloudSecurityCompliance.V1

Assembly

Google.Cloud.CloudSecurityCompliance.V1.dll

Constructors

FrameworkDeploymentName(string, string, string)

public FrameworkDeploymentName(string organizationId, string locationId, string frameworkDeploymentId)

Constructs a new instance of a FrameworkDeploymentName class from the component parts of pattern organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment}

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

The FrameworkDeployment ID. Must not be null or empty.

Properties

FrameworkDeploymentId

public string FrameworkDeploymentId { get; }

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

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. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

OrganizationId

public string OrganizationId { get; }

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

Property Value
Type Description
string

Type

public FrameworkDeploymentName.ResourceNameType Type { get; }

The FrameworkDeploymentName.ResourceNameType of the contained resource name.

Property Value
Type Description
FrameworkDeploymentNameResourceNameType

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 organizationId, string locationId, string frameworkDeploymentId)

Formats the IDs into the string representation of this FrameworkDeploymentName with pattern organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment}.

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

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

The string representation of this FrameworkDeploymentName with pattern organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment}.

FormatOrganizationLocationFrameworkDeployment(string, string, string)

public static string FormatOrganizationLocationFrameworkDeployment(string organizationId, string locationId, string frameworkDeploymentId)

Formats the IDs into the string representation of this FrameworkDeploymentName with pattern organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment}.

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

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

The string representation of this FrameworkDeploymentName with pattern organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment}.

FromOrganizationLocationFrameworkDeployment(string, string, string)

public static FrameworkDeploymentName FromOrganizationLocationFrameworkDeployment(string organizationId, string locationId, string frameworkDeploymentId)

Creates a FrameworkDeploymentName with the pattern organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment}.

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

The FrameworkDeployment ID. Must not be null or empty.
Returns
Type Description
FrameworkDeploymentName

A new instance of FrameworkDeploymentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FrameworkDeploymentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FrameworkDeploymentName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
frameworkDeploymentName string

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

The parsed FrameworkDeploymentName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment}

Parse(string, bool)

public static FrameworkDeploymentName Parse(string frameworkDeploymentName, bool allowUnparsed)

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

Parameters
Name Description
frameworkDeploymentName 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
FrameworkDeploymentName

The parsed FrameworkDeploymentName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment}
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 FrameworkDeploymentName)

public static bool TryParse(string frameworkDeploymentName, out FrameworkDeploymentName result)

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

Parameters
Name Description
frameworkDeploymentName string

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

When this method returns, the parsed FrameworkDeploymentName, 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:

  • organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment}

TryParse(string, bool, out FrameworkDeploymentName)

public static bool TryParse(string frameworkDeploymentName, bool allowUnparsed, out FrameworkDeploymentName result)

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

Parameters
Name Description
frameworkDeploymentName 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 FrameworkDeploymentName

When this method returns, the parsed FrameworkDeploymentName, 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:

  • organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(FrameworkDeploymentName, FrameworkDeploymentName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a FrameworkDeploymentName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a FrameworkDeploymentName

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

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.