Class ResourceSettingsServiceClientImpl

public sealed class ResourceSettingsServiceClientImpl : ResourceSettingsServiceClient

ResourceSettingsService client wrapper implementation, for convenient use.

Inheritance

Object > ResourceSettingsServiceClient > ResourceSettingsServiceClientImpl

Namespace

Google.Cloud.ResourceSettings.V1

Assembly

Google.Cloud.ResourceSettings.V1.dll

Remarks

An interface to interact with resource settings and setting values throughout the resource hierarchy.

Services may surface a number of settings for users to control how their resources behave. Values of settings applied on a given Cloud resource are evaluated hierarchically and inherited by all descendants of that resource.

For all requests, returns a google.rpc.Status with google.rpc.Code.PERMISSION_DENIED if the IAM check fails or the parent resource is not in a Cloud Organization. For all requests, returns a google.rpc.Status with google.rpc.Code.INVALID_ARGUMENT if the request is malformed.

Constructors

ResourceSettingsServiceClientImpl(ResourceSettingsService.ResourceSettingsServiceClient, ResourceSettingsServiceSettings)

public ResourceSettingsServiceClientImpl(ResourceSettingsService.ResourceSettingsServiceClient grpcClient, ResourceSettingsServiceSettings settings)

Constructs a client wrapper for the ResourceSettingsService service, with the specified gRPC client and settings.

Parameters
TypeNameDescription
ResourceSettingsService.ResourceSettingsServiceClientgrpcClient

The underlying gRPC client.

ResourceSettingsServiceSettingssettings

The base ResourceSettingsServiceSettings used within this client.

Properties

GrpcClient

public override ResourceSettingsService.ResourceSettingsServiceClient GrpcClient { get; }

The underlying gRPC ResourceSettingsService client

Property Value
TypeDescription
ResourceSettingsService.ResourceSettingsServiceClient
Overrides

Methods

GetSetting(GetSettingRequest, CallSettings)

public override Setting GetSetting(GetSettingRequest request, CallSettings callSettings = null)

Gets a setting.

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

Parameters
TypeNameDescription
GetSettingRequestrequest

The request object containing all of the parameters for the API call.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Setting

The RPC response.

Overrides

GetSettingAsync(GetSettingRequest, CallSettings)

public override Task<Setting> GetSettingAsync(GetSettingRequest request, CallSettings callSettings = null)

Gets a setting.

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

Parameters
TypeNameDescription
GetSettingRequestrequest

The request object containing all of the parameters for the API call.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Setting>

A Task containing the RPC response.

Overrides

ListSettings(ListSettingsRequest, CallSettings)

public override PagedEnumerable<ListSettingsResponse, Setting> ListSettings(ListSettingsRequest request, CallSettings callSettings = null)

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

Parameters
TypeNameDescription
ListSettingsRequestrequest

The request object containing all of the parameters for the API call.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListSettingsResponse, Setting>

A pageable sequence of Setting resources.

Overrides

ListSettingsAsync(ListSettingsRequest, CallSettings)

public override PagedAsyncEnumerable<ListSettingsResponse, Setting> ListSettingsAsync(ListSettingsRequest request, CallSettings callSettings = null)

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

Parameters
TypeNameDescription
ListSettingsRequestrequest

The request object containing all of the parameters for the API call.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListSettingsResponse, Setting>

A pageable asynchronous sequence of Setting resources.

Overrides

UpdateSetting(UpdateSettingRequest, CallSettings)

public override Setting UpdateSetting(UpdateSettingRequest request, CallSettings callSettings = null)

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
TypeNameDescription
UpdateSettingRequestrequest

The request object containing all of the parameters for the API call.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Setting

The RPC response.

Overrides

UpdateSettingAsync(UpdateSettingRequest, CallSettings)

public override Task<Setting> UpdateSettingAsync(UpdateSettingRequest request, CallSettings callSettings = null)

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
TypeNameDescription
UpdateSettingRequestrequest

The request object containing all of the parameters for the API call.

CallSettingscallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Setting>

A Task containing the RPC response.

Overrides