Resource Settings v1 API - Class ResourceSettingsService.ResourceSettingsServiceClient (2.3.0)

Version 2.3.0

• 2.4.0 (latest)
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.2.0
• 1.1.0
• 1.0.0

public class ResourceSettingsService.ResourceSettingsServiceClient : ClientBase<ResourceSettingsService.ResourceSettingsServiceClient>

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

Client for ResourceSettingsService

Inheritance

object > ClientBase > ClientBaseResourceSettingsServiceResourceSettingsServiceClient > ResourceSettingsService.ResourceSettingsServiceClient

Inherited Members

ClientBase<ResourceSettingsService.ResourceSettingsServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.ResourceSettings.V1

Assembly

Google.Cloud.ResourceSettings.V1.dll

Constructors

ResourceSettingsServiceClient()

protected ResourceSettingsServiceClient()

Protected parameterless constructor to allow creation of test doubles.

ResourceSettingsServiceClient(CallInvoker)

public ResourceSettingsServiceClient(CallInvoker callInvoker)

Creates a new client for ResourceSettingsService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

ResourceSettingsServiceClient(ChannelBase)

public ResourceSettingsServiceClient(ChannelBase channel)

Creates a new client for ResourceSettingsService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

ResourceSettingsServiceClient(ClientBaseConfiguration)

protected ResourceSettingsServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

GetSetting(GetSettingRequest, CallOptions)

public virtual Setting GetSetting(GetSettingRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Setting	The response received from the server.

GetSetting(GetSettingRequest, Metadata, DateTime?, CancellationToken)

public virtual Setting GetSetting(GetSettingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Setting	The response received from the server.

GetSettingAsync(GetSettingRequest, CallOptions)

public virtual AsyncUnaryCall<Setting> GetSettingAsync(GetSettingRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallSetting	The call object.

GetSettingAsync(GetSettingRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Setting> GetSettingAsync(GetSettingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallSetting	The call object.

ListSettings(ListSettingsRequest, CallOptions)

public virtual ListSettingsResponse ListSettings(ListSettingsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListSettingsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListSettingsResponse	The response received from the server.

ListSettings(ListSettingsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListSettingsResponse ListSettings(ListSettingsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListSettingsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListSettingsResponse	The response received from the server.

ListSettingsAsync(ListSettingsRequest, CallOptions)

public virtual AsyncUnaryCall<ListSettingsResponse> ListSettingsAsync(ListSettingsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListSettingsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListSettingsResponse	The call object.

ListSettingsAsync(ListSettingsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListSettingsResponse> ListSettingsAsync(ListSettingsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListSettingsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListSettingsResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override ResourceSettingsService.ResourceSettingsServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
ResourceSettingsServiceResourceSettingsServiceClient

Overrides

ClientBase<ResourceSettingsService.ResourceSettingsServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)

UpdateSetting(UpdateSettingRequest, CallOptions)

public virtual Setting UpdateSetting(UpdateSettingRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Setting	The response received from the server.

UpdateSetting(UpdateSettingRequest, Metadata, DateTime?, CancellationToken)

public virtual Setting UpdateSetting(UpdateSettingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Setting	The response received from the server.

UpdateSettingAsync(UpdateSettingRequest, CallOptions)

public virtual AsyncUnaryCall<Setting> UpdateSettingAsync(UpdateSettingRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallSetting	The call object.

UpdateSettingAsync(UpdateSettingRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Setting> UpdateSettingAsync(UpdateSettingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallSetting	The call object.