Class AccessApprovalServiceClient (1.0.0) 

public abstract class AccessApprovalServiceClient

AccessApprovalService client wrapper, for convenient use.

Inheritance

System.Object > AccessApprovalServiceClient

Namespace

Google.Cloud.AccessApproval.V1

Assembly

Google.Cloud.AccessApproval.V1.dll

Remarks

This API allows a customer to manage accesses to cloud resources by Google personnel. It defines the following resource model:

  • The API has a collection of [ApprovalRequest][google.cloud.accessapproval.v1.ApprovalRequest] resources, named approvalRequests/{approval_request_id}
  • The API has top-level settings per Project/Folder/Organization, named accessApprovalSettings

The service also periodically emails a list of recipients, defined at the Project/Folder/Organization level in the accessApprovalSettings, when there is a pending ApprovalRequest for them to act on. The ApprovalRequests can also optionally be published to a Cloud Pub/Sub topic owned by the customer (for Beta, the Pub/Sub setup is managed manually).

ApprovalRequests can be approved or dismissed. Google personel can only access the indicated resource or resources if the request is approved (subject to some exclusions: https://cloud.google.com/access-approval/docs/overview#exclusions).

Note: Using Access Approval functionality will mean that Google may not be able to meet the SLAs for your chosen products, as any support response times may be dramatically increased. As such the SLAs do not apply to any service disruption to the extent impacted by Customer's use of Access Approval. Do not enable Access Approval for projects where you may require high service availability and rapid response by Google Cloud Support.

After a request is approved or dismissed, no further action may be taken on it. Requests with the requested_expiration in the past or with no activity for 14 days are considered dismissed. When an approval expires, the request is considered dismissed.

If a request is not approved or dismissed, we call it pending.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the AccessApprovalService service, which is a host of "accessapproval.googleapis.com" and a port of 443.

Property Value
Type Description
System.String

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default AccessApprovalService scopes.

Property Value
Type Description
System.Collections.Generic.IReadOnlyList<System.String>
Remarks

The default AccessApprovalService scopes are:

GrpcClient

public virtual AccessApproval.AccessApprovalClient GrpcClient { get; }

The underlying gRPC AccessApprovalService client

Property Value
Type Description
AccessApproval.AccessApprovalClient

Methods

ApproveApprovalRequest(ApproveApprovalRequestMessage, CallSettings)

public virtual ApprovalRequest ApproveApprovalRequest(ApproveApprovalRequestMessage request, CallSettings callSettings = null)

Approves a request and returns the updated ApprovalRequest.

Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

Parameters
Name Description
request ApproveApprovalRequestMessage

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ApprovalRequest

The RPC response.

ApproveApprovalRequestAsync(ApproveApprovalRequestMessage, CallSettings)

public virtual Task<ApprovalRequest> ApproveApprovalRequestAsync(ApproveApprovalRequestMessage request, CallSettings callSettings = null)

Approves a request and returns the updated ApprovalRequest.

Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

Parameters
Name Description
request ApproveApprovalRequestMessage

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<ApprovalRequest>

A Task containing the RPC response.

ApproveApprovalRequestAsync(ApproveApprovalRequestMessage, CancellationToken)

public virtual Task<ApprovalRequest> ApproveApprovalRequestAsync(ApproveApprovalRequestMessage request, CancellationToken cancellationToken)

Approves a request and returns the updated ApprovalRequest.

Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

Parameters
Name Description
request ApproveApprovalRequestMessage

The request object containing all of the parameters for the API call.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task<ApprovalRequest>

A Task containing the RPC response.

Create()

public static AccessApprovalServiceClient Create()

Synchronously creates a AccessApprovalServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use AccessApprovalServiceClientBuilder.

Returns
Type Description
AccessApprovalServiceClient

The created AccessApprovalServiceClient.

CreateAsync(CancellationToken)

public static Task<AccessApprovalServiceClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))

Asynchronously creates a AccessApprovalServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use AccessApprovalServiceClientBuilder.

Parameter
Name Description
cancellationToken System.Threading.CancellationToken

The System.Threading.CancellationToken to use while creating the client.
Returns
Type Description
System.Threading.Tasks.Task<AccessApprovalServiceClient>

The task representing the created AccessApprovalServiceClient.

DeleteAccessApprovalSettings(DeleteAccessApprovalSettingsMessage, CallSettings)

public virtual void DeleteAccessApprovalSettings(DeleteAccessApprovalSettingsMessage request, CallSettings callSettings = null)

Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.

Parameters
Name Description
request DeleteAccessApprovalSettingsMessage

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

DeleteAccessApprovalSettings(String, CallSettings)

public virtual void DeleteAccessApprovalSettings(string name, CallSettings callSettings = null)

Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.

Parameters
Name Description
name System.String

Name of the AccessApprovalSettings to delete.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

DeleteAccessApprovalSettingsAsync(DeleteAccessApprovalSettingsMessage, CallSettings)

public virtual Task DeleteAccessApprovalSettingsAsync(DeleteAccessApprovalSettingsMessage request, CallSettings callSettings = null)

Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.

Parameters
Name Description
request DeleteAccessApprovalSettingsMessage

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

DeleteAccessApprovalSettingsAsync(DeleteAccessApprovalSettingsMessage, CancellationToken)

public virtual Task DeleteAccessApprovalSettingsAsync(DeleteAccessApprovalSettingsMessage request, CancellationToken cancellationToken)

Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.

Parameters
Name Description
request DeleteAccessApprovalSettingsMessage

The request object containing all of the parameters for the API call.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

DeleteAccessApprovalSettingsAsync(String, CallSettings)

public virtual Task DeleteAccessApprovalSettingsAsync(string name, CallSettings callSettings = null)

Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.

Parameters
Name Description
name System.String

Name of the AccessApprovalSettings to delete.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

DeleteAccessApprovalSettingsAsync(String, CancellationToken)

public virtual Task DeleteAccessApprovalSettingsAsync(string name, CancellationToken cancellationToken)

Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.

Parameters
Name Description
name System.String

Name of the AccessApprovalSettings to delete.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

DismissApprovalRequest(DismissApprovalRequestMessage, CallSettings)

public virtual ApprovalRequest DismissApprovalRequest(DismissApprovalRequestMessage request, CallSettings callSettings = null)

Dismisses a request. Returns the updated ApprovalRequest.

NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether.

Returns NOT_FOUND if the request does not exist.

Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

Parameters
Name Description
request DismissApprovalRequestMessage

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ApprovalRequest

The RPC response.

DismissApprovalRequestAsync(DismissApprovalRequestMessage, CallSettings)

public virtual Task<ApprovalRequest> DismissApprovalRequestAsync(DismissApprovalRequestMessage request, CallSettings callSettings = null)

Dismisses a request. Returns the updated ApprovalRequest.

NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether.

Returns NOT_FOUND if the request does not exist.

Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

Parameters
Name Description
request DismissApprovalRequestMessage

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<ApprovalRequest>

A Task containing the RPC response.

DismissApprovalRequestAsync(DismissApprovalRequestMessage, CancellationToken)

public virtual Task<ApprovalRequest> DismissApprovalRequestAsync(DismissApprovalRequestMessage request, CancellationToken cancellationToken)

Dismisses a request. Returns the updated ApprovalRequest.

NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether.

Returns NOT_FOUND if the request does not exist.

Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

Parameters
Name Description
request DismissApprovalRequestMessage

The request object containing all of the parameters for the API call.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task<ApprovalRequest>

A Task containing the RPC response.

GetAccessApprovalSettings(GetAccessApprovalSettingsMessage, CallSettings)

public virtual AccessApprovalSettings GetAccessApprovalSettings(GetAccessApprovalSettingsMessage request, CallSettings callSettings = null)

Gets the settings associated with a project, folder, or organization.

Parameters
Name Description
request GetAccessApprovalSettingsMessage

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AccessApprovalSettings

The RPC response.

GetAccessApprovalSettings(String, CallSettings)

public virtual AccessApprovalSettings GetAccessApprovalSettings(string name, CallSettings callSettings = null)

Gets the settings associated with a project, folder, or organization.

Parameters
Name Description
name System.String

Name of the AccessApprovalSettings to retrieve.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AccessApprovalSettings

The RPC response.

GetAccessApprovalSettingsAsync(GetAccessApprovalSettingsMessage, CallSettings)

public virtual Task<AccessApprovalSettings> GetAccessApprovalSettingsAsync(GetAccessApprovalSettingsMessage request, CallSettings callSettings = null)

Gets the settings associated with a project, folder, or organization.

Parameters
Name Description
request GetAccessApprovalSettingsMessage

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<AccessApprovalSettings>

A Task containing the RPC response.

GetAccessApprovalSettingsAsync(GetAccessApprovalSettingsMessage, CancellationToken)

public virtual Task<AccessApprovalSettings> GetAccessApprovalSettingsAsync(GetAccessApprovalSettingsMessage request, CancellationToken cancellationToken)

Gets the settings associated with a project, folder, or organization.

Parameters
Name Description
request GetAccessApprovalSettingsMessage

The request object containing all of the parameters for the API call.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task<AccessApprovalSettings>

A Task containing the RPC response.

GetAccessApprovalSettingsAsync(String, CallSettings)

public virtual Task<AccessApprovalSettings> GetAccessApprovalSettingsAsync(string name, CallSettings callSettings = null)

Gets the settings associated with a project, folder, or organization.

Parameters
Name Description
name System.String

Name of the AccessApprovalSettings to retrieve.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<AccessApprovalSettings>

A Task containing the RPC response.

GetAccessApprovalSettingsAsync(String, CancellationToken)

public virtual Task<AccessApprovalSettings> GetAccessApprovalSettingsAsync(string name, CancellationToken cancellationToken)

Gets the settings associated with a project, folder, or organization.

Parameters
Name Description
name System.String

Name of the AccessApprovalSettings to retrieve.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task<AccessApprovalSettings>

A Task containing the RPC response.

GetApprovalRequest(GetApprovalRequestMessage, CallSettings)

public virtual ApprovalRequest GetApprovalRequest(GetApprovalRequestMessage request, CallSettings callSettings = null)

Gets an approval request. Returns NOT_FOUND if the request does not exist.

Parameters
Name Description
request GetApprovalRequestMessage

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ApprovalRequest

The RPC response.

GetApprovalRequest(String, CallSettings)

public virtual ApprovalRequest GetApprovalRequest(string name, CallSettings callSettings = null)

Gets an approval request. Returns NOT_FOUND if the request does not exist.

Parameters
Name Description
name System.String

Name of the approval request to retrieve.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ApprovalRequest

The RPC response.

GetApprovalRequestAsync(GetApprovalRequestMessage, CallSettings)

public virtual Task<ApprovalRequest> GetApprovalRequestAsync(GetApprovalRequestMessage request, CallSettings callSettings = null)

Gets an approval request. Returns NOT_FOUND if the request does not exist.

Parameters
Name Description
request GetApprovalRequestMessage

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<ApprovalRequest>

A Task containing the RPC response.

GetApprovalRequestAsync(GetApprovalRequestMessage, CancellationToken)

public virtual Task<ApprovalRequest> GetApprovalRequestAsync(GetApprovalRequestMessage request, CancellationToken cancellationToken)

Gets an approval request. Returns NOT_FOUND if the request does not exist.

Parameters
Name Description
request GetApprovalRequestMessage

The request object containing all of the parameters for the API call.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task<ApprovalRequest>

A Task containing the RPC response.

GetApprovalRequestAsync(String, CallSettings)

public virtual Task<ApprovalRequest> GetApprovalRequestAsync(string name, CallSettings callSettings = null)

Gets an approval request. Returns NOT_FOUND if the request does not exist.

Parameters
Name Description
name System.String

Name of the approval request to retrieve.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<ApprovalRequest>

A Task containing the RPC response.

GetApprovalRequestAsync(String, CancellationToken)

public virtual Task<ApprovalRequest> GetApprovalRequestAsync(string name, CancellationToken cancellationToken)

Gets an approval request. Returns NOT_FOUND if the request does not exist.

Parameters
Name Description
name System.String

Name of the approval request to retrieve.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task<ApprovalRequest>

A Task containing the RPC response.

ListApprovalRequests(ListApprovalRequestsMessage, CallSettings)

public virtual PagedEnumerable<ListApprovalRequestsResponse, ApprovalRequest> ListApprovalRequests(ListApprovalRequestsMessage request, CallSettings callSettings = null)

Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.

Parameters
Name Description
request ListApprovalRequestsMessage

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Google.Api.Gax.PagedEnumerable<ListApprovalRequestsResponse, ApprovalRequest>

A pageable sequence of ApprovalRequest resources.

ListApprovalRequests(String, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListApprovalRequestsResponse, ApprovalRequest> ListApprovalRequests(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.

Parameters
Name Description
parent System.String

The parent resource. This may be "projects/{project_id}", "folders/{folder_id}", or "organizations/{organization_id}".
pageToken System.String

The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize System.Nullable<System.Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Google.Api.Gax.PagedEnumerable<ListApprovalRequestsResponse, ApprovalRequest>

A pageable sequence of ApprovalRequest resources.

ListApprovalRequestsAsync(ListApprovalRequestsMessage, CallSettings)

public virtual PagedAsyncEnumerable<ListApprovalRequestsResponse, ApprovalRequest> ListApprovalRequestsAsync(ListApprovalRequestsMessage request, CallSettings callSettings = null)

Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.

Parameters
Name Description
request ListApprovalRequestsMessage

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Google.Api.Gax.PagedAsyncEnumerable<ListApprovalRequestsResponse, ApprovalRequest>

A pageable asynchronous sequence of ApprovalRequest resources.

ListApprovalRequestsAsync(String, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListApprovalRequestsResponse, ApprovalRequest> ListApprovalRequestsAsync(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.

Parameters
Name Description
parent System.String

The parent resource. This may be "projects/{project_id}", "folders/{folder_id}", or "organizations/{organization_id}".
pageToken System.String

The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize System.Nullable<System.Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Google.Api.Gax.PagedAsyncEnumerable<ListApprovalRequestsResponse, ApprovalRequest>

A pageable asynchronous sequence of ApprovalRequest resources.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
System.Threading.Tasks.Task

A task representing the asynchronous shutdown operation.
Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateAccessApprovalSettings(AccessApprovalSettings, FieldMask, CallSettings)

public virtual AccessApprovalSettings UpdateAccessApprovalSettings(AccessApprovalSettings settings, FieldMask updateMask, CallSettings callSettings = null)

Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.

Parameters
Name Description
settings AccessApprovalSettings

The new AccessApprovalSettings.
updateMask Google.Protobuf.WellKnownTypes.FieldMask

The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails &amp; enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request.

For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AccessApprovalSettings

The RPC response.

UpdateAccessApprovalSettings(UpdateAccessApprovalSettingsMessage, CallSettings)

public virtual AccessApprovalSettings UpdateAccessApprovalSettings(UpdateAccessApprovalSettingsMessage request, CallSettings callSettings = null)

Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.

Parameters
Name Description
request UpdateAccessApprovalSettingsMessage

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AccessApprovalSettings

The RPC response.

UpdateAccessApprovalSettingsAsync(AccessApprovalSettings, FieldMask, CallSettings)

public virtual Task<AccessApprovalSettings> UpdateAccessApprovalSettingsAsync(AccessApprovalSettings settings, FieldMask updateMask, CallSettings callSettings = null)

Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.

Parameters
Name Description
settings AccessApprovalSettings

The new AccessApprovalSettings.
updateMask Google.Protobuf.WellKnownTypes.FieldMask

The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails &amp; enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request.

For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<AccessApprovalSettings>

A Task containing the RPC response.

UpdateAccessApprovalSettingsAsync(AccessApprovalSettings, FieldMask, CancellationToken)

public virtual Task<AccessApprovalSettings> UpdateAccessApprovalSettingsAsync(AccessApprovalSettings settings, FieldMask updateMask, CancellationToken cancellationToken)

Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.

Parameters
Name Description
settings AccessApprovalSettings

The new AccessApprovalSettings.
updateMask Google.Protobuf.WellKnownTypes.FieldMask

The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails &amp; enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request.

For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task<AccessApprovalSettings>

A Task containing the RPC response.

UpdateAccessApprovalSettingsAsync(UpdateAccessApprovalSettingsMessage, CallSettings)

public virtual Task<AccessApprovalSettings> UpdateAccessApprovalSettingsAsync(UpdateAccessApprovalSettingsMessage request, CallSettings callSettings = null)

Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.

Parameters
Name Description
request UpdateAccessApprovalSettingsMessage

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<AccessApprovalSettings>

A Task containing the RPC response.

UpdateAccessApprovalSettingsAsync(UpdateAccessApprovalSettingsMessage, CancellationToken)

public virtual Task<AccessApprovalSettings> UpdateAccessApprovalSettingsAsync(UpdateAccessApprovalSettingsMessage request, CancellationToken cancellationToken)

Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.

Parameters
Name Description
request UpdateAccessApprovalSettingsMessage

The request object containing all of the parameters for the API call.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task<AccessApprovalSettings>

A Task containing the RPC response.