Class Service

Namespace

OpenServiceBroker.Catalogs

Assembly

OpenServiceBroker.Model.dll

Describes a service available on the Service Broker.

public class Service : IEquatable<Service>

Inheritance

object

Service

Implements

IEquatable<Service>

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

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

Properties

Bindable

Specifies whether Service Instances of the service can be bound to applications. This specifies the default for all plans of this service. Plans can override this field.

[JsonProperty("bindable", Required = Required.Always)]
public bool Bindable { get; set; }

Property Value

bool

See Also

Plan

BindingsRetrievable

Specifies whether the Fetching a Service Binding endpoint is supported for all plans.

[JsonProperty("bindings_retrievable")]
public bool BindingsRetrievable { get; set; }

Property Value

bool

DashboardClient

A Cloud Foundry extension described in Catalog Extensions. Contains the data necessary to activate the Dashboard SSO feature for this service.

[JsonProperty("dashboard_client")]
public DashboardClient DashboardClient { get; set; }

Property Value

DashboardClient

Description

A short description of the service. MUST be a non-empty string.

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

Property Value

string

Id

An identifier used to correlate this service in future requests to the Service Broker. This MUST be globally unique such that Platforms (and their users) MUST be able to assume that seeing the same value (no matter what Service Broker uses it) will always refer to this service. MUST be a non-empty string. Using a GUID is RECOMMENDED.

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

Property Value

string

InstancesRetrievable

Specifies whether the Fetching a Service Instance endpoint is supported for all plans.

[JsonProperty("instances_retrievable")]
public bool InstancesRetrievable { get; set; }

Property Value

bool

Metadata

An opaque object of metadata for a Service Offering. It is expected that Platforms will treat this as a blob. Note that there are conventions in existing Service Brokers and Platforms for fields that aid in the display of catalog data.

[JsonProperty("metadata")]
public JObject Metadata { get; set; }

Property Value

JObject

Name

A CLI-friendly name of the service. MUST only contain alphanumeric characters, periods, and hyphens (no spaces). MUST be unique across all service objects returned in this response. MUST be a non-empty string.

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

Property Value

string

PlanUpdateable

Whether the service supports upgrade/downgrade for some plans.

[JsonProperty("plan_updateable")]
public bool PlanUpdateable { get; set; }

Property Value

bool

Plans

A list of plans for this service. MUST contain at least one plan.

[JsonProperty("plans", Required = Required.Always)]
public List<Plan> Plans { get; }

Property Value

List<Plan>

Requires

A list of permissions that the user would have to give the service, if they provision it.

[JsonProperty("requires", ItemConverterType = typeof(StringEnumConverter))]
public List<Features> Requires { get; }

Property Value

List<Features>

Tags

Tags provide a flexible mechanism to expose a classification, attribute, or base technology of a service, enabling equivalent services to be swapped out without changes to dependent logic in applications, buildpacks, or other services. E.g. mysql, relational, redis, key-value, caching, messaging, amqp.

[JsonProperty("tags")]
public List<string> Tags { get; }

Property Value

List<string>

Methods

Equals(Service)

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

public bool Equals(Service other)

Parameters

other Service

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.