Interface OsConfigServiceGrpc.AsyncService (2.54.0)

public static interface OsConfigServiceGrpc.AsyncService

OS Config API The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances.

Methods

cancelPatchJob(PatchJobs.CancelPatchJobRequest request, StreamObserver<PatchJobs.PatchJob> responseObserver)

public default void cancelPatchJob(PatchJobs.CancelPatchJobRequest request, StreamObserver<PatchJobs.PatchJob> responseObserver)

Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.

Parameters
Name Description
request PatchJobs.CancelPatchJobRequest
responseObserver io.grpc.stub.StreamObserver<PatchJob>

createGuestPolicy(GuestPolicies.CreateGuestPolicyRequest request, StreamObserver<GuestPolicies.GuestPolicy> responseObserver)

public default void createGuestPolicy(GuestPolicies.CreateGuestPolicyRequest request, StreamObserver<GuestPolicies.GuestPolicy> responseObserver)

Create an OS Config guest policy.

Parameters
Name Description
request GuestPolicies.CreateGuestPolicyRequest
responseObserver io.grpc.stub.StreamObserver<GuestPolicy>

createPatchDeployment(PatchDeployments.CreatePatchDeploymentRequest request, StreamObserver<PatchDeployments.PatchDeployment> responseObserver)

public default void createPatchDeployment(PatchDeployments.CreatePatchDeploymentRequest request, StreamObserver<PatchDeployments.PatchDeployment> responseObserver)

Create an OS Config patch deployment.

Parameters
Name Description
request PatchDeployments.CreatePatchDeploymentRequest
responseObserver io.grpc.stub.StreamObserver<PatchDeployment>

deleteGuestPolicy(GuestPolicies.DeleteGuestPolicyRequest request, StreamObserver<Empty> responseObserver)

public default void deleteGuestPolicy(GuestPolicies.DeleteGuestPolicyRequest request, StreamObserver<Empty> responseObserver)

Delete an OS Config guest policy.

Parameters
Name Description
request GuestPolicies.DeleteGuestPolicyRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deletePatchDeployment(PatchDeployments.DeletePatchDeploymentRequest request, StreamObserver<Empty> responseObserver)

public default void deletePatchDeployment(PatchDeployments.DeletePatchDeploymentRequest request, StreamObserver<Empty> responseObserver)

Delete an OS Config patch deployment.

Parameters
Name Description
request PatchDeployments.DeletePatchDeploymentRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

executePatchJob(PatchJobs.ExecutePatchJobRequest request, StreamObserver<PatchJobs.PatchJob> responseObserver)

public default void executePatchJob(PatchJobs.ExecutePatchJobRequest request, StreamObserver<PatchJobs.PatchJob> responseObserver)

Patch VM instances by creating and running a patch job.

Parameters
Name Description
request PatchJobs.ExecutePatchJobRequest
responseObserver io.grpc.stub.StreamObserver<PatchJob>

getGuestPolicy(GuestPolicies.GetGuestPolicyRequest request, StreamObserver<GuestPolicies.GuestPolicy> responseObserver)

public default void getGuestPolicy(GuestPolicies.GetGuestPolicyRequest request, StreamObserver<GuestPolicies.GuestPolicy> responseObserver)

Get an OS Config guest policy.

Parameters
Name Description
request GuestPolicies.GetGuestPolicyRequest
responseObserver io.grpc.stub.StreamObserver<GuestPolicy>

getPatchDeployment(PatchDeployments.GetPatchDeploymentRequest request, StreamObserver<PatchDeployments.PatchDeployment> responseObserver)

public default void getPatchDeployment(PatchDeployments.GetPatchDeploymentRequest request, StreamObserver<PatchDeployments.PatchDeployment> responseObserver)

Get an OS Config patch deployment.

Parameters
Name Description
request PatchDeployments.GetPatchDeploymentRequest
responseObserver io.grpc.stub.StreamObserver<PatchDeployment>

getPatchJob(PatchJobs.GetPatchJobRequest request, StreamObserver<PatchJobs.PatchJob> responseObserver)

public default void getPatchJob(PatchJobs.GetPatchJobRequest request, StreamObserver<PatchJobs.PatchJob> responseObserver)

Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.

Parameters
Name Description
request PatchJobs.GetPatchJobRequest
responseObserver io.grpc.stub.StreamObserver<PatchJob>

listGuestPolicies(GuestPolicies.ListGuestPoliciesRequest request, StreamObserver<GuestPolicies.ListGuestPoliciesResponse> responseObserver)

public default void listGuestPolicies(GuestPolicies.ListGuestPoliciesRequest request, StreamObserver<GuestPolicies.ListGuestPoliciesResponse> responseObserver)

Get a page of OS Config guest policies.

Parameters
Name Description
request GuestPolicies.ListGuestPoliciesRequest
responseObserver io.grpc.stub.StreamObserver<ListGuestPoliciesResponse>

listPatchDeployments(PatchDeployments.ListPatchDeploymentsRequest request, StreamObserver<PatchDeployments.ListPatchDeploymentsResponse> responseObserver)

public default void listPatchDeployments(PatchDeployments.ListPatchDeploymentsRequest request, StreamObserver<PatchDeployments.ListPatchDeploymentsResponse> responseObserver)

Get a page of OS Config patch deployments.

Parameters
Name Description
request PatchDeployments.ListPatchDeploymentsRequest
responseObserver io.grpc.stub.StreamObserver<ListPatchDeploymentsResponse>

listPatchJobInstanceDetails(PatchJobs.ListPatchJobInstanceDetailsRequest request, StreamObserver<PatchJobs.ListPatchJobInstanceDetailsResponse> responseObserver)

public default void listPatchJobInstanceDetails(PatchJobs.ListPatchJobInstanceDetailsRequest request, StreamObserver<PatchJobs.ListPatchJobInstanceDetailsResponse> responseObserver)

Get a list of instance details for a given patch job.

Parameters
Name Description
request PatchJobs.ListPatchJobInstanceDetailsRequest
responseObserver io.grpc.stub.StreamObserver<ListPatchJobInstanceDetailsResponse>

listPatchJobs(PatchJobs.ListPatchJobsRequest request, StreamObserver<PatchJobs.ListPatchJobsResponse> responseObserver)

public default void listPatchJobs(PatchJobs.ListPatchJobsRequest request, StreamObserver<PatchJobs.ListPatchJobsResponse> responseObserver)

Get a list of patch jobs.

Parameters
Name Description
request PatchJobs.ListPatchJobsRequest
responseObserver io.grpc.stub.StreamObserver<ListPatchJobsResponse>

lookupEffectiveGuestPolicy(GuestPolicies.LookupEffectiveGuestPolicyRequest request, StreamObserver<GuestPolicies.EffectiveGuestPolicy> responseObserver)

public default void lookupEffectiveGuestPolicy(GuestPolicies.LookupEffectiveGuestPolicyRequest request, StreamObserver<GuestPolicies.EffectiveGuestPolicy> responseObserver)

Lookup the effective guest policy that applies to a VM instance. This lookup merges all policies that are assigned to the instance ancestry.

Parameters
Name Description
request GuestPolicies.LookupEffectiveGuestPolicyRequest
responseObserver io.grpc.stub.StreamObserver<EffectiveGuestPolicy>

pausePatchDeployment(PatchDeployments.PausePatchDeploymentRequest request, StreamObserver<PatchDeployments.PatchDeployment> responseObserver)

public default void pausePatchDeployment(PatchDeployments.PausePatchDeploymentRequest request, StreamObserver<PatchDeployments.PatchDeployment> responseObserver)

Change state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs.

Parameters
Name Description
request PatchDeployments.PausePatchDeploymentRequest
responseObserver io.grpc.stub.StreamObserver<PatchDeployment>

resumePatchDeployment(PatchDeployments.ResumePatchDeploymentRequest request, StreamObserver<PatchDeployments.PatchDeployment> responseObserver)

public default void resumePatchDeployment(PatchDeployments.ResumePatchDeploymentRequest request, StreamObserver<PatchDeployments.PatchDeployment> responseObserver)

Change state of patch deployment back to "ACTIVE". Patch deployment in active state continues to generate patch jobs.

Parameters
Name Description
request PatchDeployments.ResumePatchDeploymentRequest
responseObserver io.grpc.stub.StreamObserver<PatchDeployment>

updateGuestPolicy(GuestPolicies.UpdateGuestPolicyRequest request, StreamObserver<GuestPolicies.GuestPolicy> responseObserver)

public default void updateGuestPolicy(GuestPolicies.UpdateGuestPolicyRequest request, StreamObserver<GuestPolicies.GuestPolicy> responseObserver)

Update an OS Config guest policy.

Parameters
Name Description
request GuestPolicies.UpdateGuestPolicyRequest
responseObserver io.grpc.stub.StreamObserver<GuestPolicy>

updatePatchDeployment(PatchDeployments.UpdatePatchDeploymentRequest request, StreamObserver<PatchDeployments.PatchDeployment> responseObserver)

public default void updatePatchDeployment(PatchDeployments.UpdatePatchDeploymentRequest request, StreamObserver<PatchDeployments.PatchDeployment> responseObserver)

Update an OS Config patch deployment.

Parameters
Name Description
request PatchDeployments.UpdatePatchDeploymentRequest
responseObserver io.grpc.stub.StreamObserver<PatchDeployment>