public class PrivilegedAccessManager.PrivilegedAccessManagerClient : ClientBase<PrivilegedAccessManager.PrivilegedAccessManagerClient>
Reference documentation and code samples for the Privileged Access Manager v1 API class PrivilegedAccessManager.PrivilegedAccessManagerClient.
Client for PrivilegedAccessManager
Inheritance
object > ClientBase > ClientBasePrivilegedAccessManagerPrivilegedAccessManagerClient > PrivilegedAccessManager.PrivilegedAccessManagerClientNamespace
Google.Cloud.PrivilegedAccessManager.V1Assembly
Google.Cloud.PrivilegedAccessManager.V1.dll
Constructors
PrivilegedAccessManagerClient()
protected PrivilegedAccessManagerClient()
Protected parameterless constructor to allow creation of test doubles.
PrivilegedAccessManagerClient(CallInvoker)
public PrivilegedAccessManagerClient(CallInvoker callInvoker)
Creates a new client for PrivilegedAccessManager that uses a custom CallInvoker
.
Parameter | |
---|---|
Name | Description |
callInvoker |
CallInvoker The callInvoker to use to make remote calls. |
PrivilegedAccessManagerClient(ChannelBase)
public PrivilegedAccessManagerClient(ChannelBase channel)
Creates a new client for PrivilegedAccessManager
Parameter | |
---|---|
Name | Description |
channel |
ChannelBase The channel to use to make remote calls. |
PrivilegedAccessManagerClient(ClientBaseConfiguration)
protected PrivilegedAccessManagerClient(ClientBase.ClientBaseConfiguration configuration)
Protected constructor to allow creation of configured clients.
Parameter | |
---|---|
Name | Description |
configuration |
ClientBaseClientBaseConfiguration The client configuration. |
Methods
ApproveGrant(ApproveGrantRequest, CallOptions)
public virtual Grant ApproveGrant(ApproveGrantRequest request, CallOptions options)
ApproveGrant
is used to approve a grant. This method can only be called
on a grant when it's in the APPROVAL_AWAITED
state. This operation can't
be undone.
Parameters | |
---|---|
Name | Description |
request |
ApproveGrantRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Grant |
The response received from the server. |
ApproveGrant(ApproveGrantRequest, Metadata, DateTime?, CancellationToken)
public virtual Grant ApproveGrant(ApproveGrantRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
ApproveGrant
is used to approve a grant. This method can only be called
on a grant when it's in the APPROVAL_AWAITED
state. This operation can't
be undone.
Parameters | |
---|---|
Name | Description |
request |
ApproveGrantRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
Grant |
The response received from the server. |
ApproveGrantAsync(ApproveGrantRequest, CallOptions)
public virtual AsyncUnaryCall<Grant> ApproveGrantAsync(ApproveGrantRequest request, CallOptions options)
ApproveGrant
is used to approve a grant. This method can only be called
on a grant when it's in the APPROVAL_AWAITED
state. This operation can't
be undone.
Parameters | |
---|---|
Name | Description |
request |
ApproveGrantRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallGrant |
The call object. |
ApproveGrantAsync(ApproveGrantRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Grant> ApproveGrantAsync(ApproveGrantRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
ApproveGrant
is used to approve a grant. This method can only be called
on a grant when it's in the APPROVAL_AWAITED
state. This operation can't
be undone.
Parameters | |
---|---|
Name | Description |
request |
ApproveGrantRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
AsyncUnaryCallGrant |
The call object. |
CheckOnboardingStatus(CheckOnboardingStatusRequest, CallOptions)
public virtual CheckOnboardingStatusResponse CheckOnboardingStatus(CheckOnboardingStatusRequest request, CallOptions options)
CheckOnboardingStatus
reports the onboarding status for a
project/folder/organization. Any findings reported by this API need to be
fixed before PAM can be used on the resource.
Parameters | |
---|---|
Name | Description |
request |
CheckOnboardingStatusRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
CheckOnboardingStatusResponse |
The response received from the server. |
CheckOnboardingStatus(CheckOnboardingStatusRequest, Metadata, DateTime?, CancellationToken)
public virtual CheckOnboardingStatusResponse CheckOnboardingStatus(CheckOnboardingStatusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
CheckOnboardingStatus
reports the onboarding status for a
project/folder/organization. Any findings reported by this API need to be
fixed before PAM can be used on the resource.
Parameters | |
---|---|
Name | Description |
request |
CheckOnboardingStatusRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
CheckOnboardingStatusResponse |
The response received from the server. |
CheckOnboardingStatusAsync(CheckOnboardingStatusRequest, CallOptions)
public virtual AsyncUnaryCall<CheckOnboardingStatusResponse> CheckOnboardingStatusAsync(CheckOnboardingStatusRequest request, CallOptions options)
CheckOnboardingStatus
reports the onboarding status for a
project/folder/organization. Any findings reported by this API need to be
fixed before PAM can be used on the resource.
Parameters | |
---|---|
Name | Description |
request |
CheckOnboardingStatusRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallCheckOnboardingStatusResponse |
The call object. |
CheckOnboardingStatusAsync(CheckOnboardingStatusRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<CheckOnboardingStatusResponse> CheckOnboardingStatusAsync(CheckOnboardingStatusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
CheckOnboardingStatus
reports the onboarding status for a
project/folder/organization. Any findings reported by this API need to be
fixed before PAM can be used on the resource.
Parameters | |
---|---|
Name | Description |
request |
CheckOnboardingStatusRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
AsyncUnaryCallCheckOnboardingStatusResponse |
The call object. |
CreateEntitlement(CreateEntitlementRequest, CallOptions)
public virtual Operation CreateEntitlement(CreateEntitlementRequest request, CallOptions options)
Creates a new entitlement in a given project/folder/organization and location.
Parameters | |
---|---|
Name | Description |
request |
CreateEntitlementRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
CreateEntitlement(CreateEntitlementRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation CreateEntitlement(CreateEntitlementRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Creates a new entitlement in a given project/folder/organization and location.
Parameters | |
---|---|
Name | Description |
request |
CreateEntitlementRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
Operation |
The response received from the server. |
CreateEntitlementAsync(CreateEntitlementRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> CreateEntitlementAsync(CreateEntitlementRequest request, CallOptions options)
Creates a new entitlement in a given project/folder/organization and location.
Parameters | |
---|---|
Name | Description |
request |
CreateEntitlementRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
CreateEntitlementAsync(CreateEntitlementRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateEntitlementAsync(CreateEntitlementRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Creates a new entitlement in a given project/folder/organization and location.
Parameters | |
---|---|
Name | Description |
request |
CreateEntitlementRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
AsyncUnaryCallOperation |
The call object. |
CreateGrant(CreateGrantRequest, CallOptions)
public virtual Grant CreateGrant(CreateGrantRequest request, CallOptions options)
Creates a new grant in a given project/folder/organization and location.
Parameters | |
---|---|
Name | Description |
request |
CreateGrantRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Grant |
The response received from the server. |
CreateGrant(CreateGrantRequest, Metadata, DateTime?, CancellationToken)
public virtual Grant CreateGrant(CreateGrantRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Creates a new grant in a given project/folder/organization and location.
Parameters | |
---|---|
Name | Description |
request |
CreateGrantRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
Grant |
The response received from the server. |
CreateGrantAsync(CreateGrantRequest, CallOptions)
public virtual AsyncUnaryCall<Grant> CreateGrantAsync(CreateGrantRequest request, CallOptions options)
Creates a new grant in a given project/folder/organization and location.
Parameters | |
---|---|
Name | Description |
request |
CreateGrantRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallGrant |
The call object. |
CreateGrantAsync(CreateGrantRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Grant> CreateGrantAsync(CreateGrantRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Creates a new grant in a given project/folder/organization and location.
Parameters | |
---|---|
Name | Description |
request |
CreateGrantRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
AsyncUnaryCallGrant |
The call object. |
CreateLocationsClient()
public virtual Locations.LocationsClient CreateLocationsClient()
Creates a new instance of Locations.LocationsClient using the same call invoker as this client.
Returns | |
---|---|
Type | Description |
LocationsLocationsClient |
A new Locations.LocationsClient for the same target as this client. |
CreateOperationsClient()
public virtual Operations.OperationsClient CreateOperationsClient()
Creates a new instance of Operations.OperationsClient using the same call invoker as this client.
Returns | |
---|---|
Type | Description |
OperationsOperationsClient |
A new Operations client for the same target as this client. |
DeleteEntitlement(DeleteEntitlementRequest, CallOptions)
public virtual Operation DeleteEntitlement(DeleteEntitlementRequest request, CallOptions options)
Deletes a single entitlement. This method can only be called when there
are no in-progress (ACTIVE
/ACTIVATING
/REVOKING
) grants under the
entitlement.
Parameters | |
---|---|
Name | Description |
request |
DeleteEntitlementRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
DeleteEntitlement(DeleteEntitlementRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation DeleteEntitlement(DeleteEntitlementRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Deletes a single entitlement. This method can only be called when there
are no in-progress (ACTIVE
/ACTIVATING
/REVOKING
) grants under the
entitlement.
Parameters | |
---|---|
Name | Description |
request |
DeleteEntitlementRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
Operation |
The response received from the server. |
DeleteEntitlementAsync(DeleteEntitlementRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteEntitlementAsync(DeleteEntitlementRequest request, CallOptions options)
Deletes a single entitlement. This method can only be called when there
are no in-progress (ACTIVE
/ACTIVATING
/REVOKING
) grants under the
entitlement.
Parameters | |
---|---|
Name | Description |
request |
DeleteEntitlementRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteEntitlementAsync(DeleteEntitlementRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteEntitlementAsync(DeleteEntitlementRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Deletes a single entitlement. This method can only be called when there
are no in-progress (ACTIVE
/ACTIVATING
/REVOKING
) grants under the
entitlement.
Parameters | |
---|---|
Name | Description |
request |
DeleteEntitlementRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
AsyncUnaryCallOperation |
The call object. |
DenyGrant(DenyGrantRequest, CallOptions)
public virtual Grant DenyGrant(DenyGrantRequest request, CallOptions options)
DenyGrant
is used to deny a grant. This method can only be called on a
grant when it's in the APPROVAL_AWAITED
state. This operation can't be
undone.
Parameters | |
---|---|
Name | Description |
request |
DenyGrantRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Grant |
The response received from the server. |
DenyGrant(DenyGrantRequest, Metadata, DateTime?, CancellationToken)
public virtual Grant DenyGrant(DenyGrantRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
DenyGrant
is used to deny a grant. This method can only be called on a
grant when it's in the APPROVAL_AWAITED
state. This operation can't be
undone.
Parameters | |
---|---|
Name | Description |
request |
DenyGrantRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
Grant |
The response received from the server. |
DenyGrantAsync(DenyGrantRequest, CallOptions)
public virtual AsyncUnaryCall<Grant> DenyGrantAsync(DenyGrantRequest request, CallOptions options)
DenyGrant
is used to deny a grant. This method can only be called on a
grant when it's in the APPROVAL_AWAITED
state. This operation can't be
undone.
Parameters | |
---|---|
Name | Description |
request |
DenyGrantRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallGrant |
The call object. |
DenyGrantAsync(DenyGrantRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Grant> DenyGrantAsync(DenyGrantRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
DenyGrant
is used to deny a grant. This method can only be called on a
grant when it's in the APPROVAL_AWAITED
state. This operation can't be
undone.
Parameters | |
---|---|
Name | Description |
request |
DenyGrantRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
AsyncUnaryCallGrant |
The call object. |
GetEntitlement(GetEntitlementRequest, CallOptions)
public virtual Entitlement GetEntitlement(GetEntitlementRequest request, CallOptions options)
Gets details of a single entitlement.
Parameters | |
---|---|
Name | Description |
request |
GetEntitlementRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Entitlement |
The response received from the server. |
GetEntitlement(GetEntitlementRequest, Metadata, DateTime?, CancellationToken)
public virtual Entitlement GetEntitlement(GetEntitlementRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Gets details of a single entitlement.
Parameters | |
---|---|
Name | Description |
request |
GetEntitlementRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
Entitlement |
The response received from the server. |
GetEntitlementAsync(GetEntitlementRequest, CallOptions)
public virtual AsyncUnaryCall<Entitlement> GetEntitlementAsync(GetEntitlementRequest request, CallOptions options)
Gets details of a single entitlement.
Parameters | |
---|---|
Name | Description |
request |
GetEntitlementRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEntitlement |
The call object. |
GetEntitlementAsync(GetEntitlementRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Entitlement> GetEntitlementAsync(GetEntitlementRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Gets details of a single entitlement.
Parameters | |
---|---|
Name | Description |
request |
GetEntitlementRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
AsyncUnaryCallEntitlement |
The call object. |
GetGrant(GetGrantRequest, CallOptions)
public virtual Grant GetGrant(GetGrantRequest request, CallOptions options)
Get details of a single grant.
Parameters | |
---|---|
Name | Description |
request |
GetGrantRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Grant |
The response received from the server. |
GetGrant(GetGrantRequest, Metadata, DateTime?, CancellationToken)
public virtual Grant GetGrant(GetGrantRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Get details of a single grant.
Parameters | |
---|---|
Name | Description |
request |
GetGrantRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
Grant |
The response received from the server. |
GetGrantAsync(GetGrantRequest, CallOptions)
public virtual AsyncUnaryCall<Grant> GetGrantAsync(GetGrantRequest request, CallOptions options)
Get details of a single grant.
Parameters | |
---|---|
Name | Description |
request |
GetGrantRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallGrant |
The call object. |
GetGrantAsync(GetGrantRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Grant> GetGrantAsync(GetGrantRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Get details of a single grant.
Parameters | |
---|---|
Name | Description |
request |
GetGrantRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
AsyncUnaryCallGrant |
The call object. |
ListEntitlements(ListEntitlementsRequest, CallOptions)
public virtual ListEntitlementsResponse ListEntitlements(ListEntitlementsRequest request, CallOptions options)
Lists entitlements in a given project/folder/organization and location.
Parameters | |
---|---|
Name | Description |
request |
ListEntitlementsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ListEntitlementsResponse |
The response received from the server. |
ListEntitlements(ListEntitlementsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListEntitlementsResponse ListEntitlements(ListEntitlementsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Lists entitlements in a given project/folder/organization and location.
Parameters | |
---|---|
Name | Description |
request |
ListEntitlementsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
ListEntitlementsResponse |
The response received from the server. |
ListEntitlementsAsync(ListEntitlementsRequest, CallOptions)
public virtual AsyncUnaryCall<ListEntitlementsResponse> ListEntitlementsAsync(ListEntitlementsRequest request, CallOptions options)
Lists entitlements in a given project/folder/organization and location.
Parameters | |
---|---|
Name | Description |
request |
ListEntitlementsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListEntitlementsResponse |
The call object. |
ListEntitlementsAsync(ListEntitlementsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListEntitlementsResponse> ListEntitlementsAsync(ListEntitlementsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Lists entitlements in a given project/folder/organization and location.
Parameters | |
---|---|
Name | Description |
request |
ListEntitlementsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
AsyncUnaryCallListEntitlementsResponse |
The call object. |
ListGrants(ListGrantsRequest, CallOptions)
public virtual ListGrantsResponse ListGrants(ListGrantsRequest request, CallOptions options)
Lists grants for a given entitlement.
Parameters | |
---|---|
Name | Description |
request |
ListGrantsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ListGrantsResponse |
The response received from the server. |
ListGrants(ListGrantsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListGrantsResponse ListGrants(ListGrantsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Lists grants for a given entitlement.
Parameters | |
---|---|
Name | Description |
request |
ListGrantsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
ListGrantsResponse |
The response received from the server. |
ListGrantsAsync(ListGrantsRequest, CallOptions)
public virtual AsyncUnaryCall<ListGrantsResponse> ListGrantsAsync(ListGrantsRequest request, CallOptions options)
Lists grants for a given entitlement.
Parameters | |
---|---|
Name | Description |
request |
ListGrantsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListGrantsResponse |
The call object. |
ListGrantsAsync(ListGrantsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListGrantsResponse> ListGrantsAsync(ListGrantsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Lists grants for a given entitlement.
Parameters | |
---|---|
Name | Description |
request |
ListGrantsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
AsyncUnaryCallListGrantsResponse |
The call object. |
NewInstance(ClientBaseConfiguration)
protected override PrivilegedAccessManager.PrivilegedAccessManagerClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Creates a new instance of client from given ClientBaseConfiguration
.
Parameter | |
---|---|
Name | Description |
configuration |
ClientBaseClientBaseConfiguration |
Returns | |
---|---|
Type | Description |
PrivilegedAccessManagerPrivilegedAccessManagerClient |
RevokeGrant(RevokeGrantRequest, CallOptions)
public virtual Operation RevokeGrant(RevokeGrantRequest request, CallOptions options)
RevokeGrant
is used to immediately revoke access for a grant. This method
can be called when the grant is in a non-terminal state.
Parameters | |
---|---|
Name | Description |
request |
RevokeGrantRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
RevokeGrant(RevokeGrantRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation RevokeGrant(RevokeGrantRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
RevokeGrant
is used to immediately revoke access for a grant. This method
can be called when the grant is in a non-terminal state.
Parameters | |
---|---|
Name | Description |
request |
RevokeGrantRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
Operation |
The response received from the server. |
RevokeGrantAsync(RevokeGrantRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> RevokeGrantAsync(RevokeGrantRequest request, CallOptions options)
RevokeGrant
is used to immediately revoke access for a grant. This method
can be called when the grant is in a non-terminal state.
Parameters | |
---|---|
Name | Description |
request |
RevokeGrantRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
RevokeGrantAsync(RevokeGrantRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> RevokeGrantAsync(RevokeGrantRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
RevokeGrant
is used to immediately revoke access for a grant. This method
can be called when the grant is in a non-terminal state.
Parameters | |
---|---|
Name | Description |
request |
RevokeGrantRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
AsyncUnaryCallOperation |
The call object. |
SearchEntitlements(SearchEntitlementsRequest, CallOptions)
public virtual SearchEntitlementsResponse SearchEntitlements(SearchEntitlementsRequest request, CallOptions options)
SearchEntitlements
returns entitlements on which the caller has the
specified access.
Parameters | |
---|---|
Name | Description |
request |
SearchEntitlementsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
SearchEntitlementsResponse |
The response received from the server. |
SearchEntitlements(SearchEntitlementsRequest, Metadata, DateTime?, CancellationToken)
public virtual SearchEntitlementsResponse SearchEntitlements(SearchEntitlementsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
SearchEntitlements
returns entitlements on which the caller has the
specified access.
Parameters | |
---|---|
Name | Description |
request |
SearchEntitlementsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
SearchEntitlementsResponse |
The response received from the server. |
SearchEntitlementsAsync(SearchEntitlementsRequest, CallOptions)
public virtual AsyncUnaryCall<SearchEntitlementsResponse> SearchEntitlementsAsync(SearchEntitlementsRequest request, CallOptions options)
SearchEntitlements
returns entitlements on which the caller has the
specified access.
Parameters | |
---|---|
Name | Description |
request |
SearchEntitlementsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallSearchEntitlementsResponse |
The call object. |
SearchEntitlementsAsync(SearchEntitlementsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<SearchEntitlementsResponse> SearchEntitlementsAsync(SearchEntitlementsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
SearchEntitlements
returns entitlements on which the caller has the
specified access.
Parameters | |
---|---|
Name | Description |
request |
SearchEntitlementsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
AsyncUnaryCallSearchEntitlementsResponse |
The call object. |
SearchGrants(SearchGrantsRequest, CallOptions)
public virtual SearchGrantsResponse SearchGrants(SearchGrantsRequest request, CallOptions options)
SearchGrants
returns grants that are related to the calling user in the
specified way.
Parameters | |
---|---|
Name | Description |
request |
SearchGrantsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
SearchGrantsResponse |
The response received from the server. |
SearchGrants(SearchGrantsRequest, Metadata, DateTime?, CancellationToken)
public virtual SearchGrantsResponse SearchGrants(SearchGrantsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
SearchGrants
returns grants that are related to the calling user in the
specified way.
Parameters | |
---|---|
Name | Description |
request |
SearchGrantsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
SearchGrantsResponse |
The response received from the server. |
SearchGrantsAsync(SearchGrantsRequest, CallOptions)
public virtual AsyncUnaryCall<SearchGrantsResponse> SearchGrantsAsync(SearchGrantsRequest request, CallOptions options)
SearchGrants
returns grants that are related to the calling user in the
specified way.
Parameters | |
---|---|
Name | Description |
request |
SearchGrantsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallSearchGrantsResponse |
The call object. |
SearchGrantsAsync(SearchGrantsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<SearchGrantsResponse> SearchGrantsAsync(SearchGrantsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
SearchGrants
returns grants that are related to the calling user in the
specified way.
Parameters | |
---|---|
Name | Description |
request |
SearchGrantsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
AsyncUnaryCallSearchGrantsResponse |
The call object. |
UpdateEntitlement(UpdateEntitlementRequest, CallOptions)
public virtual Operation UpdateEntitlement(UpdateEntitlementRequest request, CallOptions options)
Updates the entitlement specified in the request. Updated fields in the entitlement need to be specified in an update mask. The changes made to an entitlement are applicable only on future grants of the entitlement. However, if new approvers are added or existing approvers are removed from the approval workflow, the changes are effective on existing grants.
The following fields are not supported for updates:
- All immutable fields
- Entitlement name
- Resource name
- Resource type
- Adding an approval workflow in an entitlement which previously had no approval workflow.
- Deleting the approval workflow from an entitlement.
- Adding or deleting a step in the approval workflow (only one step is supported)
Note that updates are allowed on the list of approvers in an approval workflow step.
Parameters | |
---|---|
Name | Description |
request |
UpdateEntitlementRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
UpdateEntitlement(UpdateEntitlementRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation UpdateEntitlement(UpdateEntitlementRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Updates the entitlement specified in the request. Updated fields in the entitlement need to be specified in an update mask. The changes made to an entitlement are applicable only on future grants of the entitlement. However, if new approvers are added or existing approvers are removed from the approval workflow, the changes are effective on existing grants.
The following fields are not supported for updates:
- All immutable fields
- Entitlement name
- Resource name
- Resource type
- Adding an approval workflow in an entitlement which previously had no approval workflow.
- Deleting the approval workflow from an entitlement.
- Adding or deleting a step in the approval workflow (only one step is supported)
Note that updates are allowed on the list of approvers in an approval workflow step.
Parameters | |
---|---|
Name | Description |
request |
UpdateEntitlementRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
Operation |
The response received from the server. |
UpdateEntitlementAsync(UpdateEntitlementRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> UpdateEntitlementAsync(UpdateEntitlementRequest request, CallOptions options)
Updates the entitlement specified in the request. Updated fields in the entitlement need to be specified in an update mask. The changes made to an entitlement are applicable only on future grants of the entitlement. However, if new approvers are added or existing approvers are removed from the approval workflow, the changes are effective on existing grants.
The following fields are not supported for updates:
- All immutable fields
- Entitlement name
- Resource name
- Resource type
- Adding an approval workflow in an entitlement which previously had no approval workflow.
- Deleting the approval workflow from an entitlement.
- Adding or deleting a step in the approval workflow (only one step is supported)
Note that updates are allowed on the list of approvers in an approval workflow step.
Parameters | |
---|---|
Name | Description |
request |
UpdateEntitlementRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
UpdateEntitlementAsync(UpdateEntitlementRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> UpdateEntitlementAsync(UpdateEntitlementRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Updates the entitlement specified in the request. Updated fields in the entitlement need to be specified in an update mask. The changes made to an entitlement are applicable only on future grants of the entitlement. However, if new approvers are added or existing approvers are removed from the approval workflow, the changes are effective on existing grants.
The following fields are not supported for updates:
- All immutable fields
- Entitlement name
- Resource name
- Resource type
- Adding an approval workflow in an entitlement which previously had no approval workflow.
- Deleting the approval workflow from an entitlement.
- Adding or deleting a step in the approval workflow (only one step is supported)
Note that updates are allowed on the list of approvers in an approval workflow step.
Parameters | |
---|---|
Name | Description |
request |
UpdateEntitlementRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.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 |
AsyncUnaryCallOperation |
The call object. |