blob: 40cdfc75117e3373edb1e419ba1235c8fc49edf8 [file] [log] [blame]
{
"clientLibrary": {
"name": "cloud.google.com/go/osconfig/apiv1beta",
"version": "1.12.7",
"language": "GO",
"apis": [
{
"id": "google.cloud.osconfig.v1beta",
"version": "v1beta"
}
]
},
"snippets": [
{
"regionTag": "osconfig_v1beta_generated_OsConfigService_CancelPatchJob_sync",
"title": "osconfig CancelPatchJob Sample",
"description": "CancelPatchJob cancel a patch job. The patch job must be active. Canceled patch jobs\ncannot be restarted.",
"file": "Client/CancelPatchJob/main.go",
"language": "GO",
"clientMethod": {
"shortName": "CancelPatchJob",
"fullName": "google.cloud.osconfig.v1beta.Client.CancelPatchJob",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "osconfigpb.CancelPatchJobRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*osconfigpb.PatchJob",
"client": {
"shortName": "Client",
"fullName": "google.cloud.osconfig.v1beta.Client"
},
"method": {
"shortName": "CancelPatchJob",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService.CancelPatchJob",
"service": {
"shortName": "OsConfigService",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "osconfig_v1beta_generated_OsConfigService_CreateGuestPolicy_sync",
"title": "osconfig CreateGuestPolicy Sample",
"description": "CreateGuestPolicy create an OS Config guest policy.",
"file": "Client/CreateGuestPolicy/main.go",
"language": "GO",
"clientMethod": {
"shortName": "CreateGuestPolicy",
"fullName": "google.cloud.osconfig.v1beta.Client.CreateGuestPolicy",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "osconfigpb.CreateGuestPolicyRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*osconfigpb.GuestPolicy",
"client": {
"shortName": "Client",
"fullName": "google.cloud.osconfig.v1beta.Client"
},
"method": {
"shortName": "CreateGuestPolicy",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService.CreateGuestPolicy",
"service": {
"shortName": "OsConfigService",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "osconfig_v1beta_generated_OsConfigService_CreatePatchDeployment_sync",
"title": "osconfig CreatePatchDeployment Sample",
"description": "CreatePatchDeployment create an OS Config patch deployment.",
"file": "Client/CreatePatchDeployment/main.go",
"language": "GO",
"clientMethod": {
"shortName": "CreatePatchDeployment",
"fullName": "google.cloud.osconfig.v1beta.Client.CreatePatchDeployment",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "osconfigpb.CreatePatchDeploymentRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*osconfigpb.PatchDeployment",
"client": {
"shortName": "Client",
"fullName": "google.cloud.osconfig.v1beta.Client"
},
"method": {
"shortName": "CreatePatchDeployment",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService.CreatePatchDeployment",
"service": {
"shortName": "OsConfigService",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "osconfig_v1beta_generated_OsConfigService_DeleteGuestPolicy_sync",
"title": "osconfig DeleteGuestPolicy Sample",
"description": "DeleteGuestPolicy delete an OS Config guest policy.",
"file": "Client/DeleteGuestPolicy/main.go",
"language": "GO",
"clientMethod": {
"shortName": "DeleteGuestPolicy",
"fullName": "google.cloud.osconfig.v1beta.Client.DeleteGuestPolicy",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "osconfigpb.DeleteGuestPolicyRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"client": {
"shortName": "Client",
"fullName": "google.cloud.osconfig.v1beta.Client"
},
"method": {
"shortName": "DeleteGuestPolicy",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService.DeleteGuestPolicy",
"service": {
"shortName": "OsConfigService",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 51,
"type": "FULL"
}
]
},
{
"regionTag": "osconfig_v1beta_generated_OsConfigService_DeletePatchDeployment_sync",
"title": "osconfig DeletePatchDeployment Sample",
"description": "DeletePatchDeployment delete an OS Config patch deployment.",
"file": "Client/DeletePatchDeployment/main.go",
"language": "GO",
"clientMethod": {
"shortName": "DeletePatchDeployment",
"fullName": "google.cloud.osconfig.v1beta.Client.DeletePatchDeployment",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "osconfigpb.DeletePatchDeploymentRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"client": {
"shortName": "Client",
"fullName": "google.cloud.osconfig.v1beta.Client"
},
"method": {
"shortName": "DeletePatchDeployment",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService.DeletePatchDeployment",
"service": {
"shortName": "OsConfigService",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 51,
"type": "FULL"
}
]
},
{
"regionTag": "osconfig_v1beta_generated_OsConfigService_ExecutePatchJob_sync",
"title": "osconfig ExecutePatchJob Sample",
"description": "ExecutePatchJob patch VM instances by creating and running a patch job.",
"file": "Client/ExecutePatchJob/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ExecutePatchJob",
"fullName": "google.cloud.osconfig.v1beta.Client.ExecutePatchJob",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "osconfigpb.ExecutePatchJobRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*osconfigpb.PatchJob",
"client": {
"shortName": "Client",
"fullName": "google.cloud.osconfig.v1beta.Client"
},
"method": {
"shortName": "ExecutePatchJob",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService.ExecutePatchJob",
"service": {
"shortName": "OsConfigService",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "osconfig_v1beta_generated_OsConfigService_GetGuestPolicy_sync",
"title": "osconfig GetGuestPolicy Sample",
"description": "GetGuestPolicy get an OS Config guest policy.",
"file": "Client/GetGuestPolicy/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetGuestPolicy",
"fullName": "google.cloud.osconfig.v1beta.Client.GetGuestPolicy",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "osconfigpb.GetGuestPolicyRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*osconfigpb.GuestPolicy",
"client": {
"shortName": "Client",
"fullName": "google.cloud.osconfig.v1beta.Client"
},
"method": {
"shortName": "GetGuestPolicy",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService.GetGuestPolicy",
"service": {
"shortName": "OsConfigService",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "osconfig_v1beta_generated_OsConfigService_GetPatchDeployment_sync",
"title": "osconfig GetPatchDeployment Sample",
"description": "GetPatchDeployment get an OS Config patch deployment.",
"file": "Client/GetPatchDeployment/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetPatchDeployment",
"fullName": "google.cloud.osconfig.v1beta.Client.GetPatchDeployment",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "osconfigpb.GetPatchDeploymentRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*osconfigpb.PatchDeployment",
"client": {
"shortName": "Client",
"fullName": "google.cloud.osconfig.v1beta.Client"
},
"method": {
"shortName": "GetPatchDeployment",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService.GetPatchDeployment",
"service": {
"shortName": "OsConfigService",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "osconfig_v1beta_generated_OsConfigService_GetPatchJob_sync",
"title": "osconfig GetPatchJob Sample",
"description": "GetPatchJob get the patch job. This can be used to track the progress of an\nongoing patch job or review the details of completed jobs.",
"file": "Client/GetPatchJob/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetPatchJob",
"fullName": "google.cloud.osconfig.v1beta.Client.GetPatchJob",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "osconfigpb.GetPatchJobRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*osconfigpb.PatchJob",
"client": {
"shortName": "Client",
"fullName": "google.cloud.osconfig.v1beta.Client"
},
"method": {
"shortName": "GetPatchJob",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService.GetPatchJob",
"service": {
"shortName": "OsConfigService",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "osconfig_v1beta_generated_OsConfigService_ListGuestPolicies_sync",
"title": "osconfig ListGuestPolicies Sample",
"description": "ListGuestPolicies get a page of OS Config guest policies.",
"file": "Client/ListGuestPolicies/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ListGuestPolicies",
"fullName": "google.cloud.osconfig.v1beta.Client.ListGuestPolicies",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "osconfigpb.ListGuestPoliciesRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "GuestPolicyIterator",
"client": {
"shortName": "Client",
"fullName": "google.cloud.osconfig.v1beta.Client"
},
"method": {
"shortName": "ListGuestPolicies",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService.ListGuestPolicies",
"service": {
"shortName": "OsConfigService",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 66,
"type": "FULL"
}
]
},
{
"regionTag": "osconfig_v1beta_generated_OsConfigService_ListPatchDeployments_sync",
"title": "osconfig ListPatchDeployments Sample",
"description": "ListPatchDeployments get a page of OS Config patch deployments.",
"file": "Client/ListPatchDeployments/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ListPatchDeployments",
"fullName": "google.cloud.osconfig.v1beta.Client.ListPatchDeployments",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "osconfigpb.ListPatchDeploymentsRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "PatchDeploymentIterator",
"client": {
"shortName": "Client",
"fullName": "google.cloud.osconfig.v1beta.Client"
},
"method": {
"shortName": "ListPatchDeployments",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService.ListPatchDeployments",
"service": {
"shortName": "OsConfigService",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 66,
"type": "FULL"
}
]
},
{
"regionTag": "osconfig_v1beta_generated_OsConfigService_ListPatchJobInstanceDetails_sync",
"title": "osconfig ListPatchJobInstanceDetails Sample",
"description": "ListPatchJobInstanceDetails get a list of instance details for a given patch job.",
"file": "Client/ListPatchJobInstanceDetails/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ListPatchJobInstanceDetails",
"fullName": "google.cloud.osconfig.v1beta.Client.ListPatchJobInstanceDetails",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "osconfigpb.ListPatchJobInstanceDetailsRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "PatchJobInstanceDetailsIterator",
"client": {
"shortName": "Client",
"fullName": "google.cloud.osconfig.v1beta.Client"
},
"method": {
"shortName": "ListPatchJobInstanceDetails",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService.ListPatchJobInstanceDetails",
"service": {
"shortName": "OsConfigService",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 66,
"type": "FULL"
}
]
},
{
"regionTag": "osconfig_v1beta_generated_OsConfigService_ListPatchJobs_sync",
"title": "osconfig ListPatchJobs Sample",
"description": "ListPatchJobs get a list of patch jobs.",
"file": "Client/ListPatchJobs/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ListPatchJobs",
"fullName": "google.cloud.osconfig.v1beta.Client.ListPatchJobs",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "osconfigpb.ListPatchJobsRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "PatchJobIterator",
"client": {
"shortName": "Client",
"fullName": "google.cloud.osconfig.v1beta.Client"
},
"method": {
"shortName": "ListPatchJobs",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService.ListPatchJobs",
"service": {
"shortName": "OsConfigService",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 66,
"type": "FULL"
}
]
},
{
"regionTag": "osconfig_v1beta_generated_OsConfigService_LookupEffectiveGuestPolicy_sync",
"title": "osconfig LookupEffectiveGuestPolicy Sample",
"description": "LookupEffectiveGuestPolicy lookup the effective guest policy that applies to a VM instance. This\nlookup merges all policies that are assigned to the instance ancestry.",
"file": "Client/LookupEffectiveGuestPolicy/main.go",
"language": "GO",
"clientMethod": {
"shortName": "LookupEffectiveGuestPolicy",
"fullName": "google.cloud.osconfig.v1beta.Client.LookupEffectiveGuestPolicy",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "osconfigpb.LookupEffectiveGuestPolicyRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*osconfigpb.EffectiveGuestPolicy",
"client": {
"shortName": "Client",
"fullName": "google.cloud.osconfig.v1beta.Client"
},
"method": {
"shortName": "LookupEffectiveGuestPolicy",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService.LookupEffectiveGuestPolicy",
"service": {
"shortName": "OsConfigService",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "osconfig_v1beta_generated_OsConfigService_PausePatchDeployment_sync",
"title": "osconfig PausePatchDeployment Sample",
"description": "PausePatchDeployment change state of patch deployment to \"PAUSED\".\nPatch deployment in paused state doesn't generate patch jobs.",
"file": "Client/PausePatchDeployment/main.go",
"language": "GO",
"clientMethod": {
"shortName": "PausePatchDeployment",
"fullName": "google.cloud.osconfig.v1beta.Client.PausePatchDeployment",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "osconfigpb.PausePatchDeploymentRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*osconfigpb.PatchDeployment",
"client": {
"shortName": "Client",
"fullName": "google.cloud.osconfig.v1beta.Client"
},
"method": {
"shortName": "PausePatchDeployment",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService.PausePatchDeployment",
"service": {
"shortName": "OsConfigService",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "osconfig_v1beta_generated_OsConfigService_ResumePatchDeployment_sync",
"title": "osconfig ResumePatchDeployment Sample",
"description": "ResumePatchDeployment change state of patch deployment back to \"ACTIVE\".\nPatch deployment in active state continues to generate patch jobs.",
"file": "Client/ResumePatchDeployment/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ResumePatchDeployment",
"fullName": "google.cloud.osconfig.v1beta.Client.ResumePatchDeployment",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "osconfigpb.ResumePatchDeploymentRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*osconfigpb.PatchDeployment",
"client": {
"shortName": "Client",
"fullName": "google.cloud.osconfig.v1beta.Client"
},
"method": {
"shortName": "ResumePatchDeployment",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService.ResumePatchDeployment",
"service": {
"shortName": "OsConfigService",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "osconfig_v1beta_generated_OsConfigService_UpdateGuestPolicy_sync",
"title": "osconfig UpdateGuestPolicy Sample",
"description": "UpdateGuestPolicy update an OS Config guest policy.",
"file": "Client/UpdateGuestPolicy/main.go",
"language": "GO",
"clientMethod": {
"shortName": "UpdateGuestPolicy",
"fullName": "google.cloud.osconfig.v1beta.Client.UpdateGuestPolicy",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "osconfigpb.UpdateGuestPolicyRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*osconfigpb.GuestPolicy",
"client": {
"shortName": "Client",
"fullName": "google.cloud.osconfig.v1beta.Client"
},
"method": {
"shortName": "UpdateGuestPolicy",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService.UpdateGuestPolicy",
"service": {
"shortName": "OsConfigService",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "osconfig_v1beta_generated_OsConfigService_UpdatePatchDeployment_sync",
"title": "osconfig UpdatePatchDeployment Sample",
"description": "UpdatePatchDeployment update an OS Config patch deployment.",
"file": "Client/UpdatePatchDeployment/main.go",
"language": "GO",
"clientMethod": {
"shortName": "UpdatePatchDeployment",
"fullName": "google.cloud.osconfig.v1beta.Client.UpdatePatchDeployment",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "osconfigpb.UpdatePatchDeploymentRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*osconfigpb.PatchDeployment",
"client": {
"shortName": "Client",
"fullName": "google.cloud.osconfig.v1beta.Client"
},
"method": {
"shortName": "UpdatePatchDeployment",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService.UpdatePatchDeployment",
"service": {
"shortName": "OsConfigService",
"fullName": "google.cloud.osconfig.v1beta.OsConfigService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
}
]
}