Resource Settings v1 API - Class ResourceSettingsService.ResourceSettingsServiceBase (2.2.0)

[BindServiceMethod(typeof(ResourceSettingsService), "BindService")]
public abstract class ResourceSettingsService.ResourceSettingsServiceBase

Reference documentation and code samples for the Resource Settings v1 API class ResourceSettingsService.ResourceSettingsServiceBase.

Base class for server-side implementations of ResourceSettingsService

Inheritance

object > ResourceSettingsService.ResourceSettingsServiceBase

Namespace

Google.Cloud.ResourceSettings.V1

Assembly

Google.Cloud.ResourceSettings.V1.dll

Methods

GetSetting(GetSettingRequest, ServerCallContext)

public virtual Task<Setting> GetSetting(GetSettingRequest request, ServerCallContext context)

Gets a setting.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting does not exist.

Parameters
NameDescription
requestGetSettingRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskSetting

The response to send back to the client (wrapped by a task).

ListSettings(ListSettingsRequest, ServerCallContext)

public virtual Task<ListSettingsResponse> ListSettings(ListSettingsRequest request, ServerCallContext context)

Lists all the settings that are available on the Cloud resource parent.

Parameters
NameDescription
requestListSettingsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListSettingsResponse

The response to send back to the client (wrapped by a task).

UpdateSetting(UpdateSettingRequest, ServerCallContext)

public virtual Task<Setting> UpdateSetting(UpdateSettingRequest request, ServerCallContext context)

Updates a setting.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting does not exist. Returns a google.rpc.Status with google.rpc.Code.FAILED_PRECONDITION if the setting is flagged as read only. Returns a google.rpc.Status with google.rpc.Code.ABORTED if the etag supplied in the request does not match the persisted etag of the setting value.

On success, the response will contain only name, local_value and etag. The metadata and effective_value cannot be updated through this API.

Note: the supplied setting will perform a full overwrite of the local_value field.

Parameters
NameDescription
requestUpdateSettingRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskSetting

The response to send back to the client (wrapped by a task).