target.apidocs.com.google.api.services.osconfig.v1.OSConfig.Projects.Locations.OsPolicyAssignments.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-osconfig Show documentation

The newest version!







OSConfig.Projects.Locations.OsPolicyAssignments (OS Config API v1-rev20240901-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.osconfig.v1
Class OSConfig.Projects.Locations.OsPolicyAssignments



java.lang.Object


com.google.api.services.osconfig.v1.OSConfig.Projects.Locations.OsPolicyAssignments







Enclosing class:
OSConfig.Projects.Locations




public class OSConfig.Projects.Locations.OsPolicyAssignments
extends Object
The "osPolicyAssignments" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
OSConfig.Projects.Locations.OsPolicyAssignments.Create 


class 
OSConfig.Projects.Locations.OsPolicyAssignments.Delete 


class 
OSConfig.Projects.Locations.OsPolicyAssignments.Get 


class 
OSConfig.Projects.Locations.OsPolicyAssignments.List 


class 
OSConfig.Projects.Locations.OsPolicyAssignments.ListRevisions 


class 
OSConfig.Projects.Locations.OsPolicyAssignments.Operations
The "operations" collection of methods.



class 
OSConfig.Projects.Locations.OsPolicyAssignments.Patch 









Constructor Summary

Constructors 

Constructor and Description


OsPolicyAssignments() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


OSConfig.Projects.Locations.OsPolicyAssignments.Create
create(String parent,
      OSPolicyAssignment content)
Create an OS policy assignment.



OSConfig.Projects.Locations.OsPolicyAssignments.Delete
delete(String name)
Delete the OS policy assignment.



OSConfig.Projects.Locations.OsPolicyAssignments.Get
get(String name)
Retrieve an existing OS policy assignment.



OSConfig.Projects.Locations.OsPolicyAssignments.List
list(String parent)
List the OS policy assignments under the parent resource.



OSConfig.Projects.Locations.OsPolicyAssignments.ListRevisions
listRevisions(String name)
List the OS policy assignment revisions for a given OS policy assignment.



OSConfig.Projects.Locations.OsPolicyAssignments.Operations
operations()
An accessor for creating requests from the Operations collection.



OSConfig.Projects.Locations.OsPolicyAssignments.Patch
patch(String name,
     OSPolicyAssignment content)
Update an existing OS policy assignment.







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














Constructor Detail





OsPolicyAssignments
public OsPolicyAssignments()









Method Detail





create
public OSConfig.Projects.Locations.OsPolicyAssignments.Create create(String parent,
                                                                     OSPolicyAssignment content)
                                                              throws IOException
Create an OS policy assignment. This method also creates the first revision of the OS policy
 assignment. This method returns a long running operation (LRO) that contains the rollout details.
 The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.l
 ocations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/re
 st/v1/projects.locations.osPolicyAssignments.operations/cancel).

 Create a request for the method "osPolicyAssignments.create".

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

Parameters:
parent - Required. The parent resource name in the form: projects/{project}/locations/{location}. Note:
        Specify the zone of your VMs as the location.
content - the OSPolicyAssignment
Returns:
the request
Throws:
IOException








delete
public OSConfig.Projects.Locations.OsPolicyAssignments.Delete delete(String name)
                                                              throws IOException
Delete the OS policy assignment. This method creates a new revision of the OS policy assignment.
 This method returns a long running operation (LRO) that contains the rollout details. The rollout
 can be cancelled by cancelling the LRO. If the LRO completes and is not cancelled, all revisions
 associated with the OS policy assignment are deleted. For more information, see [Method: projects
 .locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/
 rest/v1/projects.locations.osPolicyAssignments.operations/cancel).

 Create a request for the method "osPolicyAssignments.delete".

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

Parameters:
name - Required. The name of the OS policy assignment to be deleted
Returns:
the request
Throws:
IOException








get
public OSConfig.Projects.Locations.OsPolicyAssignments.Get get(String name)
                                                        throws IOException
Retrieve an existing OS policy assignment. This method always returns the latest revision. In
 order to retrieve a previous revision of the assignment, also provide the revision ID in the
 `name` parameter.

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

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

Parameters:
name - Required. The resource name of OS policy assignment. Format:
        `projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}@{revis
        ionId}`
Returns:
the request
Throws:
IOException








list
public OSConfig.Projects.Locations.OsPolicyAssignments.List list(String parent)
                                                          throws IOException
List the OS policy assignments under the parent resource. For each OS policy assignment, the
 latest revision is returned.

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

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

Parameters:
parent - Required. The parent resource name.
Returns:
the request
Throws:
IOException








listRevisions
public OSConfig.Projects.Locations.OsPolicyAssignments.ListRevisions listRevisions(String name)
                                                                            throws IOException
List the OS policy assignment revisions for a given OS policy assignment.

 Create a request for the method "osPolicyAssignments.listRevisions".

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

Parameters:
name - Required. The name of the OS policy assignment to list revisions for.
Returns:
the request
Throws:
IOException








patch
public OSConfig.Projects.Locations.OsPolicyAssignments.Patch patch(String name,
                                                                   OSPolicyAssignment content)
                                                            throws IOException
Update an existing OS policy assignment. This method creates a new revision of the OS policy
 assignment. This method returns a long running operation (LRO) that contains the rollout details.
 The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.l
 ocations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/re
 st/v1/projects.locations.osPolicyAssignments.operations/cancel).

 Create a request for the method "osPolicyAssignments.patch".

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

Parameters:
name - Resource name. Format:
        `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_
        id}` This field is ignored when you create an OS policy assignment.
content - the OSPolicyAssignment
Returns:
the request
Throws:
IOException








operations
public OSConfig.Projects.Locations.OsPolicyAssignments.Operations operations()
An accessor for creating requests from the Operations collection.

 The typical use is:
     OSConfig osconfig = new OSConfig(...);
    OSConfig.Operations.List request = osconfig.operations().list(parameters ...)
 

Returns:
the resource collection














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`	`OSConfig.Projects.Locations.OsPolicyAssignments.Create`
`class`	`OSConfig.Projects.Locations.OsPolicyAssignments.Delete`
`class`	`OSConfig.Projects.Locations.OsPolicyAssignments.Get`
`class`	`OSConfig.Projects.Locations.OsPolicyAssignments.List`
`class`	`OSConfig.Projects.Locations.OsPolicyAssignments.ListRevisions`
`class`	`OSConfig.Projects.Locations.OsPolicyAssignments.Operations` The "operations" collection of methods.
`class`	`OSConfig.Projects.Locations.OsPolicyAssignments.Patch`

Modifier and Type	Method and Description
`OSConfig.Projects.Locations.OsPolicyAssignments.Create`	`create(String parent, OSPolicyAssignment content)` Create an OS policy assignment.
`OSConfig.Projects.Locations.OsPolicyAssignments.Delete`	`delete(String name)` Delete the OS policy assignment.
`OSConfig.Projects.Locations.OsPolicyAssignments.Get`	`get(String name)` Retrieve an existing OS policy assignment.
`OSConfig.Projects.Locations.OsPolicyAssignments.List`	`list(String parent)` List the OS policy assignments under the parent resource.
`OSConfig.Projects.Locations.OsPolicyAssignments.ListRevisions`	`listRevisions(String name)` List the OS policy assignment revisions for a given OS policy assignment.
`OSConfig.Projects.Locations.OsPolicyAssignments.Operations`	`operations()` An accessor for creating requests from the Operations collection.
`OSConfig.Projects.Locations.OsPolicyAssignments.Patch`	`patch(String name, OSPolicyAssignment content)` Update an existing OS policy assignment.