Interface OsConfigServiceGrpc.AsyncService (2.31.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
NameDescription
requestPatchJobs.CancelPatchJobRequest
responseObserverio.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
NameDescription
requestGuestPolicies.CreateGuestPolicyRequest
responseObserverio.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
NameDescription
requestPatchDeployments.CreatePatchDeploymentRequest
responseObserverio.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
NameDescription
requestGuestPolicies.DeleteGuestPolicyRequest
responseObserverio.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
NameDescription
requestPatchDeployments.DeletePatchDeploymentRequest
responseObserverio.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
NameDescription
requestPatchJobs.ExecutePatchJobRequest
responseObserverio.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
NameDescription
requestGuestPolicies.GetGuestPolicyRequest
responseObserverio.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
NameDescription
requestPatchDeployments.GetPatchDeploymentRequest
responseObserverio.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
NameDescription
requestPatchJobs.GetPatchJobRequest
responseObserverio.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
NameDescription
requestGuestPolicies.ListGuestPoliciesRequest
responseObserverio.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
NameDescription
requestPatchDeployments.ListPatchDeploymentsRequest
responseObserverio.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
NameDescription
requestPatchJobs.ListPatchJobInstanceDetailsRequest
responseObserverio.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
NameDescription
requestPatchJobs.ListPatchJobsRequest
responseObserverio.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
NameDescription
requestGuestPolicies.LookupEffectiveGuestPolicyRequest
responseObserverio.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
NameDescription
requestPatchDeployments.PausePatchDeploymentRequest
responseObserverio.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
NameDescription
requestPatchDeployments.ResumePatchDeploymentRequest
responseObserverio.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
NameDescription
requestGuestPolicies.UpdateGuestPolicyRequest
responseObserverio.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
NameDescription
requestPatchDeployments.UpdatePatchDeploymentRequest
responseObserverio.grpc.stub.StreamObserver<PatchDeployment>