Resource Settings v1 API - Class ResourceSettingsServiceClientImpl (2.3.0)

public sealed class ResourceSettingsServiceClientImpl : ResourceSettingsServiceClient

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

ResourceSettingsService client wrapper implementation, for convenient use.

Inheritance

object > ResourceSettingsServiceClient > ResourceSettingsServiceClientImpl

Inherited Members

ResourceSettingsServiceClient.DefaultEndpoint

ResourceSettingsServiceClient.DefaultScopes

ResourceSettingsServiceClient.ServiceMetadata

ResourceSettingsServiceClient.CreateAsync(CancellationToken)

ResourceSettingsServiceClient.Create()

ResourceSettingsServiceClient.ShutdownDefaultChannelsAsync()

ResourceSettingsServiceClient.ListSettings(string, string, int?, CallSettings)

ResourceSettingsServiceClient.ListSettingsAsync(string, string, int?, CallSettings)

ResourceSettingsServiceClient.ListSettings(IResourceName, string, int?, CallSettings)

ResourceSettingsServiceClient.ListSettingsAsync(IResourceName, string, int?, CallSettings)

ResourceSettingsServiceClient.GetSettingAsync(GetSettingRequest, CancellationToken)

ResourceSettingsServiceClient.GetSetting(string, CallSettings)

ResourceSettingsServiceClient.GetSettingAsync(string, CallSettings)

ResourceSettingsServiceClient.GetSettingAsync(string, CancellationToken)

ResourceSettingsServiceClient.GetSetting(SettingName, CallSettings)

ResourceSettingsServiceClient.GetSettingAsync(SettingName, CallSettings)

ResourceSettingsServiceClient.GetSettingAsync(SettingName, CancellationToken)

ResourceSettingsServiceClient.UpdateSettingAsync(UpdateSettingRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

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(ResourceSettingsServiceClient, ResourceSettingsServiceSettings, ILogger)

public ResourceSettingsServiceClientImpl(ResourceSettingsService.ResourceSettingsServiceClient grpcClient, ResourceSettingsServiceSettings settings, ILogger logger)

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

Parameters
Name	Description
`grpcClient`	`ResourceSettingsServiceResourceSettingsServiceClient` The underlying gRPC client.
`settings`	`ResourceSettingsServiceSettings` The base ResourceSettingsServiceSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

GrpcClient

public override ResourceSettingsService.ResourceSettingsServiceClient GrpcClient { get; }

The underlying gRPC ResourceSettingsService client

Property Value
Type	Description
`ResourceSettingsServiceResourceSettingsServiceClient`

Overrides

ResourceSettingsServiceClient.GrpcClient

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
Name	Description
`request`	`GetSettingRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Setting`	The RPC response.

Overrides

ResourceSettingsServiceClient.GetSetting(GetSettingRequest, CallSettings)

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
Name	Description
`request`	`GetSettingRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskSetting`	A Task containing the RPC response.

Overrides

ResourceSettingsServiceClient.GetSettingAsync(GetSettingRequest, CallSettings)

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
Name	Description
`request`	`ListSettingsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableListSettingsResponseSetting`	A pageable sequence of Setting resources.

Overrides

ResourceSettingsServiceClient.ListSettings(ListSettingsRequest, CallSettings)

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
Name	Description
`request`	`ListSettingsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableListSettingsResponseSetting`	A pageable asynchronous sequence of Setting resources.

Overrides

ResourceSettingsServiceClient.ListSettingsAsync(ListSettingsRequest, CallSettings)

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
Name	Description
`request`	`UpdateSettingRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Setting`	The RPC response.

Overrides

ResourceSettingsServiceClient.UpdateSetting(UpdateSettingRequest, CallSettings)

UpdateSettingAsync(UpdateSettingRequest, CallSettings)

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

Updates a setting.

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
Name	Description
`request`	`UpdateSettingRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskSetting`	A Task containing the RPC response.

Overrides

ResourceSettingsServiceClient.UpdateSettingAsync(UpdateSettingRequest, CallSettings)