Class ServiceInstanceProvisionRequest

Namespace

OpenServiceBroker.Instances

Assembly

OpenServiceBroker.Model.dll

public class ServiceInstanceProvisionRequest : ServiceInstanceBase, IServicePlanReference, IEquatable<ServiceInstanceProvisionRequest>

Inheritance

object

ServiceInstanceBase

ServiceInstanceProvisionRequest

Implements

IServicePlanReference

IEquatable<ServiceInstanceProvisionRequest>

Inherited Members

ServiceInstanceBase.ServiceId

ServiceInstanceBase.Parameters

ServiceInstanceBase.MaintenanceInfo

ServiceInstanceBase.Equals(ServiceInstanceBase)

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

CompletableWithResult.Complete<TCompletable, TResult>(TCompletable, TResult?)

Properties

Context

Platform specific contextual information under which the Service Instance is to be provisioned. Although most Service Brokers will not use this field, it could be helpful in determining data placement or applying custom business rules.

[JsonProperty("context")]
public JObject Context { get; set; }

Property Value

JObject

Remarks

This will replace OrganizationGuid and SpaceGuid in future versions of the specification - in the interim both SHOULD be used to ensure interoperability with old and new implementations.

OrganizationGuid

Deprecated in favor of Context. The Platform GUID for the organization under which the Service Instance is to be provisioned. Although most Service Brokers will not use this field, it might be helpful for executing operations on a user's behalf. MUST be a non-empty string.

[JsonProperty("organization_guid", Required = Required.Always)]
public string OrganizationGuid { get; set; }

Property Value

string

PlanId

MUST be the ID of a Plan from the service that has been requested.

[JsonProperty("plan_id", Required = Required.Always)]
public override string PlanId { get; set; }

Property Value

string

SpaceGuid

Deprecated in favor of Context. The identifier for the project space within the Platform organization. Although most Service Brokers will not use this field, it might be helpful for executing operations on a user's behalf. MUST be a non-empty string.

[JsonProperty("space_guid", Required = Required.Always)]
public string SpaceGuid { get; set; }

Property Value

string

Methods

Equals(ServiceInstanceProvisionRequest)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(ServiceInstanceProvisionRequest other)

Parameters

other ServiceInstanceProvisionRequest

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.