target.apidocs.com.google.api.services.accessapproval.v1.AccessApproval.Organizations.ApprovalRequests.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-accessapproval Show documentation

There is a newer version: v1-rev20240820-2.0.0

Show newest version







AccessApproval.Organizations.ApprovalRequests (Access Approval API v1-rev20240424-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.accessapproval.v1
Class AccessApproval.Organizations.ApprovalRequests



java.lang.Object


com.google.api.services.accessapproval.v1.AccessApproval.Organizations.ApprovalRequests







Enclosing class:
AccessApproval.Organizations




public class AccessApproval.Organizations.ApprovalRequests
extends Object
The "approvalRequests" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
AccessApproval.Organizations.ApprovalRequests.Approve 


class 
AccessApproval.Organizations.ApprovalRequests.Dismiss 


class 
AccessApproval.Organizations.ApprovalRequests.Get 


class 
AccessApproval.Organizations.ApprovalRequests.Invalidate 


class 
AccessApproval.Organizations.ApprovalRequests.List 









Constructor Summary

Constructors 

Constructor and Description


ApprovalRequests() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


AccessApproval.Organizations.ApprovalRequests.Approve
approve(String name,
       ApproveApprovalRequestMessage content)
Approves a request and returns the updated ApprovalRequest.



AccessApproval.Organizations.ApprovalRequests.Dismiss
dismiss(String name,
       DismissApprovalRequestMessage content)
Dismisses a request.



AccessApproval.Organizations.ApprovalRequests.Get
get(String name)
Gets an approval request.



AccessApproval.Organizations.ApprovalRequests.Invalidate
invalidate(String name,
          InvalidateApprovalRequestMessage content)
Invalidates an existing ApprovalRequest.



AccessApproval.Organizations.ApprovalRequests.List
list(String parent)
Lists approval requests associated with a project, folder, or organization.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





ApprovalRequests
public ApprovalRequests()









Method Detail





approve
public AccessApproval.Organizations.ApprovalRequests.Approve approve(String name,
                                                                     ApproveApprovalRequestMessage content)
                                                              throws IOException
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.

 Create a request for the method "approvalRequests.approve".

 This request holds the parameters needed by the accessapproval server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Name of the approval request to approve.
content - the ApproveApprovalRequestMessage
Returns:
the request
Throws:
IOException








dismiss
public AccessApproval.Organizations.ApprovalRequests.Dismiss dismiss(String name,
                                                                     DismissApprovalRequestMessage content)
                                                              throws IOException
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.

 Create a request for the method "approvalRequests.dismiss".

 This request holds the parameters needed by the accessapproval server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Name of the ApprovalRequest to dismiss.
content - the DismissApprovalRequestMessage
Returns:
the request
Throws:
IOException








get
public AccessApproval.Organizations.ApprovalRequests.Get get(String name)
                                                      throws IOException
Gets an approval request. Returns NOT_FOUND if the request does not exist.

 Create a request for the method "approvalRequests.get".

 This request holds the parameters needed by the accessapproval server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - The name of the approval request to retrieve. Format:
        "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}"
Returns:
the request
Throws:
IOException








invalidate
public AccessApproval.Organizations.ApprovalRequests.Invalidate invalidate(String name,
                                                                           InvalidateApprovalRequestMessage content)
                                                                    throws IOException
Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not
 deny access to the resource if another request has been made and approved. It only invalidates a
 single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved
 state.

 Create a request for the method "approvalRequests.invalidate".

 This request holds the parameters needed by the accessapproval server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Name of the ApprovalRequest to invalidate.
content - the InvalidateApprovalRequestMessage
Returns:
the request
Throws:
IOException








list
public AccessApproval.Organizations.ApprovalRequests.List list(String parent)
                                                        throws IOException
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.

 Create a request for the method "approvalRequests.list".

 This request holds the parameters needed by the accessapproval server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - The parent resource. This may be "projects/{project}", "folders/{folder}", or
        "organizations/{organization}".
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`AccessApproval.Organizations.ApprovalRequests.Approve`
`class`	`AccessApproval.Organizations.ApprovalRequests.Dismiss`
`class`	`AccessApproval.Organizations.ApprovalRequests.Get`
`class`	`AccessApproval.Organizations.ApprovalRequests.Invalidate`
`class`	`AccessApproval.Organizations.ApprovalRequests.List`

Modifier and Type	Method and Description
`AccessApproval.Organizations.ApprovalRequests.Approve`	`approve(String name, ApproveApprovalRequestMessage content)` Approves a request and returns the updated ApprovalRequest.
`AccessApproval.Organizations.ApprovalRequests.Dismiss`	`dismiss(String name, DismissApprovalRequestMessage content)` Dismisses a request.
`AccessApproval.Organizations.ApprovalRequests.Get`	`get(String name)` Gets an approval request.
`AccessApproval.Organizations.ApprovalRequests.Invalidate`	`invalidate(String name, InvalidateApprovalRequestMessage content)` Invalidates an existing ApprovalRequest.
`AccessApproval.Organizations.ApprovalRequests.List`	`list(String parent)` Lists approval requests associated with a project, folder, or organization.