Class OsConfigServiceClient (2.0.0)

public abstract class OsConfigServiceClient

OsConfigService client wrapper, for convenient use.

Inheritance

Object > OsConfigServiceClient

Namespace

Google.Cloud.OsConfig.V1

Assembly

Google.Cloud.OsConfig.V1.dll

Remarks

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.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the OsConfigService service, which is a host of "osconfig.googleapis.com" and a port of 443.

Property Value
TypeDescription
String

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default OsConfigService scopes.

Property Value
TypeDescription
IReadOnlyList<String>
Remarks

The default OsConfigService scopes are:

GrpcClient

public virtual OsConfigService.OsConfigServiceClient GrpcClient { get; }

The underlying gRPC OsConfigService client

Property Value
TypeDescription
OsConfigService.OsConfigServiceClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
ServiceMetadata

Methods

CancelPatchJob(CancelPatchJobRequest, CallSettings)

public virtual PatchJob CancelPatchJob(CancelPatchJobRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestCancelPatchJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PatchJob

The RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
CancelPatchJobRequest request = new CancelPatchJobRequest
{
    PatchJobName = PatchJobName.FromProjectPatchJob("[PROJECT]", "[PATCH_JOB]"),
};
// Make the request
PatchJob response = osConfigServiceClient.CancelPatchJob(request);

CancelPatchJobAsync(CancelPatchJobRequest, CallSettings)

public virtual Task<PatchJob> CancelPatchJobAsync(CancelPatchJobRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestCancelPatchJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PatchJob>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
CancelPatchJobRequest request = new CancelPatchJobRequest
{
    PatchJobName = PatchJobName.FromProjectPatchJob("[PROJECT]", "[PATCH_JOB]"),
};
// Make the request
PatchJob response = await osConfigServiceClient.CancelPatchJobAsync(request);

CancelPatchJobAsync(CancelPatchJobRequest, CancellationToken)

public virtual Task<PatchJob> CancelPatchJobAsync(CancelPatchJobRequest request, CancellationToken cancellationToken)

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

Parameters
NameDescription
requestCancelPatchJobRequest

The request object containing all of the parameters for the API call.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
Task<PatchJob>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
CancelPatchJobRequest request = new CancelPatchJobRequest
{
    PatchJobName = PatchJobName.FromProjectPatchJob("[PROJECT]", "[PATCH_JOB]"),
};
// Make the request
PatchJob response = await osConfigServiceClient.CancelPatchJobAsync(request);

Create()

public static OsConfigServiceClient Create()

Synchronously creates a OsConfigServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use OsConfigServiceClientBuilder.

Returns
TypeDescription
OsConfigServiceClient

The created OsConfigServiceClient.

CreateAsync(CancellationToken)

public static Task<OsConfigServiceClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))

Asynchronously creates a OsConfigServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use OsConfigServiceClientBuilder.

Parameter
NameDescription
cancellationTokenSystem.Threading.CancellationToken

The System.Threading.CancellationToken to use while creating the client.

Returns
TypeDescription
Task<OsConfigServiceClient>

The task representing the created OsConfigServiceClient.

CreatePatchDeployment(ProjectName, PatchDeployment, String, CallSettings)

public virtual PatchDeployment CreatePatchDeployment(ProjectName parent, PatchDeployment patchDeployment, string patchDeploymentId, CallSettings callSettings = null)

Create an OS Config patch deployment.

Parameters
NameDescription
parentProjectName

Required. The project to apply this patch deployment to in the form projects/*.

patchDeploymentPatchDeployment

Required. The patch deployment to create.

patchDeploymentIdString

Required. A name for the patch deployment in the project. When creating a name the following rules apply:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the project.
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PatchDeployment

The RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
PatchDeployment patchDeployment = new PatchDeployment();
string patchDeploymentId = "";
// Make the request
PatchDeployment response = osConfigServiceClient.CreatePatchDeployment(parent, patchDeployment, patchDeploymentId);

CreatePatchDeployment(CreatePatchDeploymentRequest, CallSettings)

public virtual PatchDeployment CreatePatchDeployment(CreatePatchDeploymentRequest request, CallSettings callSettings = null)

Create an OS Config patch deployment.

Parameters
NameDescription
requestCreatePatchDeploymentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PatchDeployment

The RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
CreatePatchDeploymentRequest request = new CreatePatchDeploymentRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    PatchDeploymentId = "",
    PatchDeployment = new PatchDeployment(),
};
// Make the request
PatchDeployment response = osConfigServiceClient.CreatePatchDeployment(request);

CreatePatchDeployment(String, PatchDeployment, String, CallSettings)

public virtual PatchDeployment CreatePatchDeployment(string parent, PatchDeployment patchDeployment, string patchDeploymentId, CallSettings callSettings = null)

Create an OS Config patch deployment.

Parameters
NameDescription
parentString

Required. The project to apply this patch deployment to in the form projects/*.

patchDeploymentPatchDeployment

Required. The patch deployment to create.

patchDeploymentIdString

Required. A name for the patch deployment in the project. When creating a name the following rules apply:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the project.
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PatchDeployment

The RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
PatchDeployment patchDeployment = new PatchDeployment();
string patchDeploymentId = "";
// Make the request
PatchDeployment response = osConfigServiceClient.CreatePatchDeployment(parent, patchDeployment, patchDeploymentId);

CreatePatchDeploymentAsync(ProjectName, PatchDeployment, String, CallSettings)

public virtual Task<PatchDeployment> CreatePatchDeploymentAsync(ProjectName parent, PatchDeployment patchDeployment, string patchDeploymentId, CallSettings callSettings = null)

Create an OS Config patch deployment.

Parameters
NameDescription
parentProjectName

Required. The project to apply this patch deployment to in the form projects/*.

patchDeploymentPatchDeployment

Required. The patch deployment to create.

patchDeploymentIdString

Required. A name for the patch deployment in the project. When creating a name the following rules apply:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the project.
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
PatchDeployment patchDeployment = new PatchDeployment();
string patchDeploymentId = "";
// Make the request
PatchDeployment response = await osConfigServiceClient.CreatePatchDeploymentAsync(parent, patchDeployment, patchDeploymentId);

CreatePatchDeploymentAsync(ProjectName, PatchDeployment, String, CancellationToken)

public virtual Task<PatchDeployment> CreatePatchDeploymentAsync(ProjectName parent, PatchDeployment patchDeployment, string patchDeploymentId, CancellationToken cancellationToken)

Create an OS Config patch deployment.

Parameters
NameDescription
parentProjectName

Required. The project to apply this patch deployment to in the form projects/*.

patchDeploymentPatchDeployment

Required. The patch deployment to create.

patchDeploymentIdString

Required. A name for the patch deployment in the project. When creating a name the following rules apply:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the project.
cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
PatchDeployment patchDeployment = new PatchDeployment();
string patchDeploymentId = "";
// Make the request
PatchDeployment response = await osConfigServiceClient.CreatePatchDeploymentAsync(parent, patchDeployment, patchDeploymentId);

CreatePatchDeploymentAsync(CreatePatchDeploymentRequest, CallSettings)

public virtual Task<PatchDeployment> CreatePatchDeploymentAsync(CreatePatchDeploymentRequest request, CallSettings callSettings = null)

Create an OS Config patch deployment.

Parameters
NameDescription
requestCreatePatchDeploymentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
CreatePatchDeploymentRequest request = new CreatePatchDeploymentRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    PatchDeploymentId = "",
    PatchDeployment = new PatchDeployment(),
};
// Make the request
PatchDeployment response = await osConfigServiceClient.CreatePatchDeploymentAsync(request);

CreatePatchDeploymentAsync(CreatePatchDeploymentRequest, CancellationToken)

public virtual Task<PatchDeployment> CreatePatchDeploymentAsync(CreatePatchDeploymentRequest request, CancellationToken cancellationToken)

Create an OS Config patch deployment.

Parameters
NameDescription
requestCreatePatchDeploymentRequest

The request object containing all of the parameters for the API call.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
CreatePatchDeploymentRequest request = new CreatePatchDeploymentRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    PatchDeploymentId = "",
    PatchDeployment = new PatchDeployment(),
};
// Make the request
PatchDeployment response = await osConfigServiceClient.CreatePatchDeploymentAsync(request);

CreatePatchDeploymentAsync(String, PatchDeployment, String, CallSettings)

public virtual Task<PatchDeployment> CreatePatchDeploymentAsync(string parent, PatchDeployment patchDeployment, string patchDeploymentId, CallSettings callSettings = null)

Create an OS Config patch deployment.

Parameters
NameDescription
parentString

Required. The project to apply this patch deployment to in the form projects/*.

patchDeploymentPatchDeployment

Required. The patch deployment to create.

patchDeploymentIdString

Required. A name for the patch deployment in the project. When creating a name the following rules apply:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the project.
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
PatchDeployment patchDeployment = new PatchDeployment();
string patchDeploymentId = "";
// Make the request
PatchDeployment response = await osConfigServiceClient.CreatePatchDeploymentAsync(parent, patchDeployment, patchDeploymentId);

CreatePatchDeploymentAsync(String, PatchDeployment, String, CancellationToken)

public virtual Task<PatchDeployment> CreatePatchDeploymentAsync(string parent, PatchDeployment patchDeployment, string patchDeploymentId, CancellationToken cancellationToken)

Create an OS Config patch deployment.

Parameters
NameDescription
parentString

Required. The project to apply this patch deployment to in the form projects/*.

patchDeploymentPatchDeployment

Required. The patch deployment to create.

patchDeploymentIdString

Required. A name for the patch deployment in the project. When creating a name the following rules apply:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the project.
cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
PatchDeployment patchDeployment = new PatchDeployment();
string patchDeploymentId = "";
// Make the request
PatchDeployment response = await osConfigServiceClient.CreatePatchDeploymentAsync(parent, patchDeployment, patchDeploymentId);

DeletePatchDeployment(DeletePatchDeploymentRequest, CallSettings)

public virtual void DeletePatchDeployment(DeletePatchDeploymentRequest request, CallSettings callSettings = null)

Delete an OS Config patch deployment.

Parameters
NameDescription
requestDeletePatchDeploymentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
DeletePatchDeploymentRequest request = new DeletePatchDeploymentRequest
{
    PatchDeploymentName = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]"),
};
// Make the request
osConfigServiceClient.DeletePatchDeployment(request);

DeletePatchDeployment(PatchDeploymentName, CallSettings)

public virtual void DeletePatchDeployment(PatchDeploymentName name, CallSettings callSettings = null)

Delete an OS Config patch deployment.

Parameters
NameDescription
namePatchDeploymentName

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
PatchDeploymentName name = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]");
// Make the request
osConfigServiceClient.DeletePatchDeployment(name);

DeletePatchDeployment(String, CallSettings)

public virtual void DeletePatchDeployment(string name, CallSettings callSettings = null)

Delete an OS Config patch deployment.

Parameters
NameDescription
nameString

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/patchDeployments/[PATCH_DEPLOYMENT]";
// Make the request
osConfigServiceClient.DeletePatchDeployment(name);

DeletePatchDeploymentAsync(DeletePatchDeploymentRequest, CallSettings)

public virtual Task DeletePatchDeploymentAsync(DeletePatchDeploymentRequest request, CallSettings callSettings = null)

Delete an OS Config patch deployment.

Parameters
NameDescription
requestDeletePatchDeploymentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
DeletePatchDeploymentRequest request = new DeletePatchDeploymentRequest
{
    PatchDeploymentName = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]"),
};
// Make the request
await osConfigServiceClient.DeletePatchDeploymentAsync(request);

DeletePatchDeploymentAsync(DeletePatchDeploymentRequest, CancellationToken)

public virtual Task DeletePatchDeploymentAsync(DeletePatchDeploymentRequest request, CancellationToken cancellationToken)

Delete an OS Config patch deployment.

Parameters
NameDescription
requestDeletePatchDeploymentRequest

The request object containing all of the parameters for the API call.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
DeletePatchDeploymentRequest request = new DeletePatchDeploymentRequest
{
    PatchDeploymentName = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]"),
};
// Make the request
await osConfigServiceClient.DeletePatchDeploymentAsync(request);

DeletePatchDeploymentAsync(PatchDeploymentName, CallSettings)

public virtual Task DeletePatchDeploymentAsync(PatchDeploymentName name, CallSettings callSettings = null)

Delete an OS Config patch deployment.

Parameters
NameDescription
namePatchDeploymentName

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
PatchDeploymentName name = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]");
// Make the request
await osConfigServiceClient.DeletePatchDeploymentAsync(name);

DeletePatchDeploymentAsync(PatchDeploymentName, CancellationToken)

public virtual Task DeletePatchDeploymentAsync(PatchDeploymentName name, CancellationToken cancellationToken)

Delete an OS Config patch deployment.

Parameters
NameDescription
namePatchDeploymentName

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
PatchDeploymentName name = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]");
// Make the request
await osConfigServiceClient.DeletePatchDeploymentAsync(name);

DeletePatchDeploymentAsync(String, CallSettings)

public virtual Task DeletePatchDeploymentAsync(string name, CallSettings callSettings = null)

Delete an OS Config patch deployment.

Parameters
NameDescription
nameString

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/patchDeployments/[PATCH_DEPLOYMENT]";
// Make the request
await osConfigServiceClient.DeletePatchDeploymentAsync(name);

DeletePatchDeploymentAsync(String, CancellationToken)

public virtual Task DeletePatchDeploymentAsync(string name, CancellationToken cancellationToken)

Delete an OS Config patch deployment.

Parameters
NameDescription
nameString

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/patchDeployments/[PATCH_DEPLOYMENT]";
// Make the request
await osConfigServiceClient.DeletePatchDeploymentAsync(name);

ExecutePatchJob(ExecutePatchJobRequest, CallSettings)

public virtual PatchJob ExecutePatchJob(ExecutePatchJobRequest request, CallSettings callSettings = null)

Patch VM instances by creating and running a patch job.

Parameters
NameDescription
requestExecutePatchJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PatchJob

The RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
ExecutePatchJobRequest request = new ExecutePatchJobRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Description = "",
    PatchConfig = new PatchConfig(),
    Duration = new Duration(),
    DryRun = false,
    InstanceFilter = new PatchInstanceFilter(),
    DisplayName = "",
    Rollout = new PatchRollout(),
};
// Make the request
PatchJob response = osConfigServiceClient.ExecutePatchJob(request);

ExecutePatchJobAsync(ExecutePatchJobRequest, CallSettings)

public virtual Task<PatchJob> ExecutePatchJobAsync(ExecutePatchJobRequest request, CallSettings callSettings = null)

Patch VM instances by creating and running a patch job.

Parameters
NameDescription
requestExecutePatchJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PatchJob>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
ExecutePatchJobRequest request = new ExecutePatchJobRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Description = "",
    PatchConfig = new PatchConfig(),
    Duration = new Duration(),
    DryRun = false,
    InstanceFilter = new PatchInstanceFilter(),
    DisplayName = "",
    Rollout = new PatchRollout(),
};
// Make the request
PatchJob response = await osConfigServiceClient.ExecutePatchJobAsync(request);

ExecutePatchJobAsync(ExecutePatchJobRequest, CancellationToken)

public virtual Task<PatchJob> ExecutePatchJobAsync(ExecutePatchJobRequest request, CancellationToken cancellationToken)

Patch VM instances by creating and running a patch job.

Parameters
NameDescription
requestExecutePatchJobRequest

The request object containing all of the parameters for the API call.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
Task<PatchJob>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
ExecutePatchJobRequest request = new ExecutePatchJobRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Description = "",
    PatchConfig = new PatchConfig(),
    Duration = new Duration(),
    DryRun = false,
    InstanceFilter = new PatchInstanceFilter(),
    DisplayName = "",
    Rollout = new PatchRollout(),
};
// Make the request
PatchJob response = await osConfigServiceClient.ExecutePatchJobAsync(request);

GetPatchDeployment(GetPatchDeploymentRequest, CallSettings)

public virtual PatchDeployment GetPatchDeployment(GetPatchDeploymentRequest request, CallSettings callSettings = null)

Get an OS Config patch deployment.

Parameters
NameDescription
requestGetPatchDeploymentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PatchDeployment

The RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
GetPatchDeploymentRequest request = new GetPatchDeploymentRequest
{
    PatchDeploymentName = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]"),
};
// Make the request
PatchDeployment response = osConfigServiceClient.GetPatchDeployment(request);

GetPatchDeployment(PatchDeploymentName, CallSettings)

public virtual PatchDeployment GetPatchDeployment(PatchDeploymentName name, CallSettings callSettings = null)

Get an OS Config patch deployment.

Parameters
NameDescription
namePatchDeploymentName

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PatchDeployment

The RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
PatchDeploymentName name = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]");
// Make the request
PatchDeployment response = osConfigServiceClient.GetPatchDeployment(name);

GetPatchDeployment(String, CallSettings)

public virtual PatchDeployment GetPatchDeployment(string name, CallSettings callSettings = null)

Get an OS Config patch deployment.

Parameters
NameDescription
nameString

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PatchDeployment

The RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/patchDeployments/[PATCH_DEPLOYMENT]";
// Make the request
PatchDeployment response = osConfigServiceClient.GetPatchDeployment(name);

GetPatchDeploymentAsync(GetPatchDeploymentRequest, CallSettings)

public virtual Task<PatchDeployment> GetPatchDeploymentAsync(GetPatchDeploymentRequest request, CallSettings callSettings = null)

Get an OS Config patch deployment.

Parameters
NameDescription
requestGetPatchDeploymentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
GetPatchDeploymentRequest request = new GetPatchDeploymentRequest
{
    PatchDeploymentName = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]"),
};
// Make the request
PatchDeployment response = await osConfigServiceClient.GetPatchDeploymentAsync(request);

GetPatchDeploymentAsync(GetPatchDeploymentRequest, CancellationToken)

public virtual Task<PatchDeployment> GetPatchDeploymentAsync(GetPatchDeploymentRequest request, CancellationToken cancellationToken)

Get an OS Config patch deployment.

Parameters
NameDescription
requestGetPatchDeploymentRequest

The request object containing all of the parameters for the API call.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
GetPatchDeploymentRequest request = new GetPatchDeploymentRequest
{
    PatchDeploymentName = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]"),
};
// Make the request
PatchDeployment response = await osConfigServiceClient.GetPatchDeploymentAsync(request);

GetPatchDeploymentAsync(PatchDeploymentName, CallSettings)

public virtual Task<PatchDeployment> GetPatchDeploymentAsync(PatchDeploymentName name, CallSettings callSettings = null)

Get an OS Config patch deployment.

Parameters
NameDescription
namePatchDeploymentName

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
PatchDeploymentName name = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]");
// Make the request
PatchDeployment response = await osConfigServiceClient.GetPatchDeploymentAsync(name);

GetPatchDeploymentAsync(PatchDeploymentName, CancellationToken)

public virtual Task<PatchDeployment> GetPatchDeploymentAsync(PatchDeploymentName name, CancellationToken cancellationToken)

Get an OS Config patch deployment.

Parameters
NameDescription
namePatchDeploymentName

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
PatchDeploymentName name = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]");
// Make the request
PatchDeployment response = await osConfigServiceClient.GetPatchDeploymentAsync(name);

GetPatchDeploymentAsync(String, CallSettings)

public virtual Task<PatchDeployment> GetPatchDeploymentAsync(string name, CallSettings callSettings = null)

Get an OS Config patch deployment.

Parameters
NameDescription
nameString

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/patchDeployments/[PATCH_DEPLOYMENT]";
// Make the request
PatchDeployment response = await osConfigServiceClient.GetPatchDeploymentAsync(name);

GetPatchDeploymentAsync(String, CancellationToken)

public virtual Task<PatchDeployment> GetPatchDeploymentAsync(string name, CancellationToken cancellationToken)

Get an OS Config patch deployment.

Parameters
NameDescription
nameString

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/patchDeployments/[PATCH_DEPLOYMENT]";
// Make the request
PatchDeployment response = await osConfigServiceClient.GetPatchDeploymentAsync(name);

GetPatchJob(GetPatchJobRequest, CallSettings)

public virtual PatchJob GetPatchJob(GetPatchJobRequest request, CallSettings callSettings = null)

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
requestGetPatchJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PatchJob

The RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
GetPatchJobRequest request = new GetPatchJobRequest
{
    PatchJobName = PatchJobName.FromProjectPatchJob("[PROJECT]", "[PATCH_JOB]"),
};
// Make the request
PatchJob response = osConfigServiceClient.GetPatchJob(request);

GetPatchJob(PatchJobName, CallSettings)

public virtual PatchJob GetPatchJob(PatchJobName name, CallSettings callSettings = null)

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
namePatchJobName

Required. Name of the patch in the form projects/*/patchJobs/*

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PatchJob

The RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
PatchJobName name = PatchJobName.FromProjectPatchJob("[PROJECT]", "[PATCH_JOB]");
// Make the request
PatchJob response = osConfigServiceClient.GetPatchJob(name);

GetPatchJob(String, CallSettings)

public virtual PatchJob GetPatchJob(string name, CallSettings callSettings = null)

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
nameString

Required. Name of the patch in the form projects/*/patchJobs/*

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PatchJob

The RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/patchJobs/[PATCH_JOB]";
// Make the request
PatchJob response = osConfigServiceClient.GetPatchJob(name);

GetPatchJobAsync(GetPatchJobRequest, CallSettings)

public virtual Task<PatchJob> GetPatchJobAsync(GetPatchJobRequest request, CallSettings callSettings = null)

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
requestGetPatchJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PatchJob>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
GetPatchJobRequest request = new GetPatchJobRequest
{
    PatchJobName = PatchJobName.FromProjectPatchJob("[PROJECT]", "[PATCH_JOB]"),
};
// Make the request
PatchJob response = await osConfigServiceClient.GetPatchJobAsync(request);

GetPatchJobAsync(GetPatchJobRequest, CancellationToken)

public virtual Task<PatchJob> GetPatchJobAsync(GetPatchJobRequest request, CancellationToken cancellationToken)

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
requestGetPatchJobRequest

The request object containing all of the parameters for the API call.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
Task<PatchJob>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
GetPatchJobRequest request = new GetPatchJobRequest
{
    PatchJobName = PatchJobName.FromProjectPatchJob("[PROJECT]", "[PATCH_JOB]"),
};
// Make the request
PatchJob response = await osConfigServiceClient.GetPatchJobAsync(request);

GetPatchJobAsync(PatchJobName, CallSettings)

public virtual Task<PatchJob> GetPatchJobAsync(PatchJobName name, CallSettings callSettings = null)

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
namePatchJobName

Required. Name of the patch in the form projects/*/patchJobs/*

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PatchJob>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
PatchJobName name = PatchJobName.FromProjectPatchJob("[PROJECT]", "[PATCH_JOB]");
// Make the request
PatchJob response = await osConfigServiceClient.GetPatchJobAsync(name);

GetPatchJobAsync(PatchJobName, CancellationToken)

public virtual Task<PatchJob> GetPatchJobAsync(PatchJobName name, CancellationToken cancellationToken)

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
namePatchJobName

Required. Name of the patch in the form projects/*/patchJobs/*

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
Task<PatchJob>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
PatchJobName name = PatchJobName.FromProjectPatchJob("[PROJECT]", "[PATCH_JOB]");
// Make the request
PatchJob response = await osConfigServiceClient.GetPatchJobAsync(name);

GetPatchJobAsync(String, CallSettings)

public virtual Task<PatchJob> GetPatchJobAsync(string name, CallSettings callSettings = null)

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
nameString

Required. Name of the patch in the form projects/*/patchJobs/*

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PatchJob>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/patchJobs/[PATCH_JOB]";
// Make the request
PatchJob response = await osConfigServiceClient.GetPatchJobAsync(name);

GetPatchJobAsync(String, CancellationToken)

public virtual Task<PatchJob> GetPatchJobAsync(string name, CancellationToken cancellationToken)

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
nameString

Required. Name of the patch in the form projects/*/patchJobs/*

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
Task<PatchJob>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/patchJobs/[PATCH_JOB]";
// Make the request
PatchJob response = await osConfigServiceClient.GetPatchJobAsync(name);

ListPatchDeployments(ProjectName, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListPatchDeploymentsResponse, PatchDeployment> ListPatchDeployments(ProjectName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Get a page of OS Config patch deployments.

Parameters
NameDescription
parentProjectName

Required. The resource name of the parent in the form projects/*.

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListPatchDeploymentsResponse, PatchDeployment>

A pageable sequence of PatchDeployment resources.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
PagedEnumerable<ListPatchDeploymentsResponse, PatchDeployment> response = osConfigServiceClient.ListPatchDeployments(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (PatchDeployment item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListPatchDeploymentsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PatchDeployment item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PatchDeployment> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PatchDeployment item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPatchDeployments(ListPatchDeploymentsRequest, CallSettings)

public virtual PagedEnumerable<ListPatchDeploymentsResponse, PatchDeployment> ListPatchDeployments(ListPatchDeploymentsRequest request, CallSettings callSettings = null)

Get a page of OS Config patch deployments.

Parameters
NameDescription
requestListPatchDeploymentsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListPatchDeploymentsResponse, PatchDeployment>

A pageable sequence of PatchDeployment resources.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
ListPatchDeploymentsRequest request = new ListPatchDeploymentsRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
};
// Make the request
PagedEnumerable<ListPatchDeploymentsResponse, PatchDeployment> response = osConfigServiceClient.ListPatchDeployments(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (PatchDeployment item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListPatchDeploymentsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PatchDeployment item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PatchDeployment> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PatchDeployment item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPatchDeployments(String, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListPatchDeploymentsResponse, PatchDeployment> ListPatchDeployments(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Get a page of OS Config patch deployments.

Parameters
NameDescription
parentString

Required. The resource name of the parent in the form projects/*.

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListPatchDeploymentsResponse, PatchDeployment>

A pageable sequence of PatchDeployment resources.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
PagedEnumerable<ListPatchDeploymentsResponse, PatchDeployment> response = osConfigServiceClient.ListPatchDeployments(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (PatchDeployment item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListPatchDeploymentsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PatchDeployment item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PatchDeployment> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PatchDeployment item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPatchDeploymentsAsync(ProjectName, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListPatchDeploymentsResponse, PatchDeployment> ListPatchDeploymentsAsync(ProjectName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Get a page of OS Config patch deployments.

Parameters
NameDescription
parentProjectName

Required. The resource name of the parent in the form projects/*.

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListPatchDeploymentsResponse, PatchDeployment>

A pageable asynchronous sequence of PatchDeployment resources.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
PagedAsyncEnumerable<ListPatchDeploymentsResponse, PatchDeployment> response = osConfigServiceClient.ListPatchDeploymentsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PatchDeployment item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListPatchDeploymentsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PatchDeployment item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PatchDeployment> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PatchDeployment item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPatchDeploymentsAsync(ListPatchDeploymentsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListPatchDeploymentsResponse, PatchDeployment> ListPatchDeploymentsAsync(ListPatchDeploymentsRequest request, CallSettings callSettings = null)

Get a page of OS Config patch deployments.

Parameters
NameDescription
requestListPatchDeploymentsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListPatchDeploymentsResponse, PatchDeployment>

A pageable asynchronous sequence of PatchDeployment resources.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
ListPatchDeploymentsRequest request = new ListPatchDeploymentsRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
};
// Make the request
PagedAsyncEnumerable<ListPatchDeploymentsResponse, PatchDeployment> response = osConfigServiceClient.ListPatchDeploymentsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PatchDeployment item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListPatchDeploymentsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PatchDeployment item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PatchDeployment> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PatchDeployment item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPatchDeploymentsAsync(String, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListPatchDeploymentsResponse, PatchDeployment> ListPatchDeploymentsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Get a page of OS Config patch deployments.

Parameters
NameDescription
parentString

Required. The resource name of the parent in the form projects/*.

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListPatchDeploymentsResponse, PatchDeployment>

A pageable asynchronous sequence of PatchDeployment resources.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
PagedAsyncEnumerable<ListPatchDeploymentsResponse, PatchDeployment> response = osConfigServiceClient.ListPatchDeploymentsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PatchDeployment item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListPatchDeploymentsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PatchDeployment item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PatchDeployment> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PatchDeployment item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPatchJobInstanceDetails(ListPatchJobInstanceDetailsRequest, CallSettings)

public virtual PagedEnumerable<ListPatchJobInstanceDetailsResponse, PatchJobInstanceDetails> ListPatchJobInstanceDetails(ListPatchJobInstanceDetailsRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListPatchJobInstanceDetailsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListPatchJobInstanceDetailsResponse, PatchJobInstanceDetails>

A pageable sequence of PatchJobInstanceDetails resources.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
ListPatchJobInstanceDetailsRequest request = new ListPatchJobInstanceDetailsRequest
{
    ParentAsPatchJobName = PatchJobName.FromProjectPatchJob("[PROJECT]", "[PATCH_JOB]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListPatchJobInstanceDetailsResponse, PatchJobInstanceDetails> response = osConfigServiceClient.ListPatchJobInstanceDetails(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (PatchJobInstanceDetails item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListPatchJobInstanceDetailsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PatchJobInstanceDetails item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PatchJobInstanceDetails> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PatchJobInstanceDetails item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPatchJobInstanceDetails(PatchJobName, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListPatchJobInstanceDetailsResponse, PatchJobInstanceDetails> ListPatchJobInstanceDetails(PatchJobName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
NameDescription
parentPatchJobName

Required. The parent for the instances are in the form of projects/*/patchJobs/*.

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListPatchJobInstanceDetailsResponse, PatchJobInstanceDetails>

A pageable sequence of PatchJobInstanceDetails resources.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
PatchJobName parent = PatchJobName.FromProjectPatchJob("[PROJECT]", "[PATCH_JOB]");
// Make the request
PagedEnumerable<ListPatchJobInstanceDetailsResponse, PatchJobInstanceDetails> response = osConfigServiceClient.ListPatchJobInstanceDetails(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (PatchJobInstanceDetails item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListPatchJobInstanceDetailsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PatchJobInstanceDetails item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PatchJobInstanceDetails> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PatchJobInstanceDetails item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPatchJobInstanceDetails(String, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListPatchJobInstanceDetailsResponse, PatchJobInstanceDetails> ListPatchJobInstanceDetails(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
NameDescription
parentString

Required. The parent for the instances are in the form of projects/*/patchJobs/*.

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListPatchJobInstanceDetailsResponse, PatchJobInstanceDetails>

A pageable sequence of PatchJobInstanceDetails resources.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/patchJobs/[PATCH_JOB]";
// Make the request
PagedEnumerable<ListPatchJobInstanceDetailsResponse, PatchJobInstanceDetails> response = osConfigServiceClient.ListPatchJobInstanceDetails(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (PatchJobInstanceDetails item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListPatchJobInstanceDetailsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PatchJobInstanceDetails item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PatchJobInstanceDetails> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PatchJobInstanceDetails item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPatchJobInstanceDetailsAsync(ListPatchJobInstanceDetailsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListPatchJobInstanceDetailsResponse, PatchJobInstanceDetails> ListPatchJobInstanceDetailsAsync(ListPatchJobInstanceDetailsRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListPatchJobInstanceDetailsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListPatchJobInstanceDetailsResponse, PatchJobInstanceDetails>

A pageable asynchronous sequence of PatchJobInstanceDetails resources.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
ListPatchJobInstanceDetailsRequest request = new ListPatchJobInstanceDetailsRequest
{
    ParentAsPatchJobName = PatchJobName.FromProjectPatchJob("[PROJECT]", "[PATCH_JOB]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListPatchJobInstanceDetailsResponse, PatchJobInstanceDetails> response = osConfigServiceClient.ListPatchJobInstanceDetailsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PatchJobInstanceDetails item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListPatchJobInstanceDetailsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PatchJobInstanceDetails item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PatchJobInstanceDetails> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PatchJobInstanceDetails item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPatchJobInstanceDetailsAsync(PatchJobName, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListPatchJobInstanceDetailsResponse, PatchJobInstanceDetails> ListPatchJobInstanceDetailsAsync(PatchJobName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
NameDescription
parentPatchJobName

Required. The parent for the instances are in the form of projects/*/patchJobs/*.

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListPatchJobInstanceDetailsResponse, PatchJobInstanceDetails>

A pageable asynchronous sequence of PatchJobInstanceDetails resources.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
PatchJobName parent = PatchJobName.FromProjectPatchJob("[PROJECT]", "[PATCH_JOB]");
// Make the request
PagedAsyncEnumerable<ListPatchJobInstanceDetailsResponse, PatchJobInstanceDetails> response = osConfigServiceClient.ListPatchJobInstanceDetailsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PatchJobInstanceDetails item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListPatchJobInstanceDetailsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PatchJobInstanceDetails item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PatchJobInstanceDetails> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PatchJobInstanceDetails item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPatchJobInstanceDetailsAsync(String, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListPatchJobInstanceDetailsResponse, PatchJobInstanceDetails> ListPatchJobInstanceDetailsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
NameDescription
parentString

Required. The parent for the instances are in the form of projects/*/patchJobs/*.

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListPatchJobInstanceDetailsResponse, PatchJobInstanceDetails>

A pageable asynchronous sequence of PatchJobInstanceDetails resources.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/patchJobs/[PATCH_JOB]";
// Make the request
PagedAsyncEnumerable<ListPatchJobInstanceDetailsResponse, PatchJobInstanceDetails> response = osConfigServiceClient.ListPatchJobInstanceDetailsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PatchJobInstanceDetails item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListPatchJobInstanceDetailsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PatchJobInstanceDetails item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PatchJobInstanceDetails> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PatchJobInstanceDetails item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPatchJobs(ProjectName, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListPatchJobsResponse, PatchJob> ListPatchJobs(ProjectName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Get a list of patch jobs.

Parameters
NameDescription
parentProjectName

Required. In the form of projects/*

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListPatchJobsResponse, PatchJob>

A pageable sequence of PatchJob resources.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
PagedEnumerable<ListPatchJobsResponse, PatchJob> response = osConfigServiceClient.ListPatchJobs(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (PatchJob item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListPatchJobsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PatchJob item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PatchJob> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PatchJob item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPatchJobs(ListPatchJobsRequest, CallSettings)

public virtual PagedEnumerable<ListPatchJobsResponse, PatchJob> ListPatchJobs(ListPatchJobsRequest request, CallSettings callSettings = null)

Get a list of patch jobs.

Parameters
NameDescription
requestListPatchJobsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListPatchJobsResponse, PatchJob>

A pageable sequence of PatchJob resources.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
ListPatchJobsRequest request = new ListPatchJobsRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListPatchJobsResponse, PatchJob> response = osConfigServiceClient.ListPatchJobs(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (PatchJob item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListPatchJobsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PatchJob item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PatchJob> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PatchJob item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPatchJobs(String, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListPatchJobsResponse, PatchJob> ListPatchJobs(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Get a list of patch jobs.

Parameters
NameDescription
parentString

Required. In the form of projects/*

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListPatchJobsResponse, PatchJob>

A pageable sequence of PatchJob resources.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
PagedEnumerable<ListPatchJobsResponse, PatchJob> response = osConfigServiceClient.ListPatchJobs(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (PatchJob item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListPatchJobsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PatchJob item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PatchJob> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PatchJob item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPatchJobsAsync(ProjectName, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListPatchJobsResponse, PatchJob> ListPatchJobsAsync(ProjectName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Get a list of patch jobs.

Parameters
NameDescription
parentProjectName

Required. In the form of projects/*

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListPatchJobsResponse, PatchJob>

A pageable asynchronous sequence of PatchJob resources.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
PagedAsyncEnumerable<ListPatchJobsResponse, PatchJob> response = osConfigServiceClient.ListPatchJobsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PatchJob item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListPatchJobsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PatchJob item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PatchJob> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PatchJob item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPatchJobsAsync(ListPatchJobsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListPatchJobsResponse, PatchJob> ListPatchJobsAsync(ListPatchJobsRequest request, CallSettings callSettings = null)

Get a list of patch jobs.

Parameters
NameDescription
requestListPatchJobsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListPatchJobsResponse, PatchJob>

A pageable asynchronous sequence of PatchJob resources.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
ListPatchJobsRequest request = new ListPatchJobsRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListPatchJobsResponse, PatchJob> response = osConfigServiceClient.ListPatchJobsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PatchJob item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListPatchJobsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PatchJob item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PatchJob> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PatchJob item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListPatchJobsAsync(String, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListPatchJobsResponse, PatchJob> ListPatchJobsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Get a list of patch jobs.

Parameters
NameDescription
parentString

Required. In the form of projects/*

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListPatchJobsResponse, PatchJob>

A pageable asynchronous sequence of PatchJob resources.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
PagedAsyncEnumerable<ListPatchJobsResponse, PatchJob> response = osConfigServiceClient.ListPatchJobsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PatchJob item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListPatchJobsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PatchJob item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<PatchJob> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (PatchJob item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PausePatchDeployment(PatchDeploymentName, CallSettings)

public virtual PatchDeployment PausePatchDeployment(PatchDeploymentName name, CallSettings callSettings = null)

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

Parameters
NameDescription
namePatchDeploymentName

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PatchDeployment

The RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
PatchDeploymentName name = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]");
// Make the request
PatchDeployment response = osConfigServiceClient.PausePatchDeployment(name);

PausePatchDeployment(PausePatchDeploymentRequest, CallSettings)

public virtual PatchDeployment PausePatchDeployment(PausePatchDeploymentRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestPausePatchDeploymentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PatchDeployment

The RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
PausePatchDeploymentRequest request = new PausePatchDeploymentRequest
{
    PatchDeploymentName = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]"),
};
// Make the request
PatchDeployment response = osConfigServiceClient.PausePatchDeployment(request);

PausePatchDeployment(String, CallSettings)

public virtual PatchDeployment PausePatchDeployment(string name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameString

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PatchDeployment

The RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/patchDeployments/[PATCH_DEPLOYMENT]";
// Make the request
PatchDeployment response = osConfigServiceClient.PausePatchDeployment(name);

PausePatchDeploymentAsync(PatchDeploymentName, CallSettings)

public virtual Task<PatchDeployment> PausePatchDeploymentAsync(PatchDeploymentName name, CallSettings callSettings = null)

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

Parameters
NameDescription
namePatchDeploymentName

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
PatchDeploymentName name = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]");
// Make the request
PatchDeployment response = await osConfigServiceClient.PausePatchDeploymentAsync(name);

PausePatchDeploymentAsync(PatchDeploymentName, CancellationToken)

public virtual Task<PatchDeployment> PausePatchDeploymentAsync(PatchDeploymentName name, CancellationToken cancellationToken)

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

Parameters
NameDescription
namePatchDeploymentName

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
PatchDeploymentName name = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]");
// Make the request
PatchDeployment response = await osConfigServiceClient.PausePatchDeploymentAsync(name);

PausePatchDeploymentAsync(PausePatchDeploymentRequest, CallSettings)

public virtual Task<PatchDeployment> PausePatchDeploymentAsync(PausePatchDeploymentRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestPausePatchDeploymentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
PausePatchDeploymentRequest request = new PausePatchDeploymentRequest
{
    PatchDeploymentName = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]"),
};
// Make the request
PatchDeployment response = await osConfigServiceClient.PausePatchDeploymentAsync(request);

PausePatchDeploymentAsync(PausePatchDeploymentRequest, CancellationToken)

public virtual Task<PatchDeployment> PausePatchDeploymentAsync(PausePatchDeploymentRequest request, CancellationToken cancellationToken)

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

Parameters
NameDescription
requestPausePatchDeploymentRequest

The request object containing all of the parameters for the API call.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
PausePatchDeploymentRequest request = new PausePatchDeploymentRequest
{
    PatchDeploymentName = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]"),
};
// Make the request
PatchDeployment response = await osConfigServiceClient.PausePatchDeploymentAsync(request);

PausePatchDeploymentAsync(String, CallSettings)

public virtual Task<PatchDeployment> PausePatchDeploymentAsync(string name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameString

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/patchDeployments/[PATCH_DEPLOYMENT]";
// Make the request
PatchDeployment response = await osConfigServiceClient.PausePatchDeploymentAsync(name);

PausePatchDeploymentAsync(String, CancellationToken)

public virtual Task<PatchDeployment> PausePatchDeploymentAsync(string name, CancellationToken cancellationToken)

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

Parameters
NameDescription
nameString

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/patchDeployments/[PATCH_DEPLOYMENT]";
// Make the request
PatchDeployment response = await osConfigServiceClient.PausePatchDeploymentAsync(name);

ResumePatchDeployment(PatchDeploymentName, CallSettings)

public virtual PatchDeployment ResumePatchDeployment(PatchDeploymentName name, CallSettings callSettings = null)

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

Parameters
NameDescription
namePatchDeploymentName

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PatchDeployment

The RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
PatchDeploymentName name = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]");
// Make the request
PatchDeployment response = osConfigServiceClient.ResumePatchDeployment(name);

ResumePatchDeployment(ResumePatchDeploymentRequest, CallSettings)

public virtual PatchDeployment ResumePatchDeployment(ResumePatchDeploymentRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestResumePatchDeploymentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PatchDeployment

The RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
ResumePatchDeploymentRequest request = new ResumePatchDeploymentRequest
{
    PatchDeploymentName = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]"),
};
// Make the request
PatchDeployment response = osConfigServiceClient.ResumePatchDeployment(request);

ResumePatchDeployment(String, CallSettings)

public virtual PatchDeployment ResumePatchDeployment(string name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameString

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PatchDeployment

The RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/patchDeployments/[PATCH_DEPLOYMENT]";
// Make the request
PatchDeployment response = osConfigServiceClient.ResumePatchDeployment(name);

ResumePatchDeploymentAsync(PatchDeploymentName, CallSettings)

public virtual Task<PatchDeployment> ResumePatchDeploymentAsync(PatchDeploymentName name, CallSettings callSettings = null)

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

Parameters
NameDescription
namePatchDeploymentName

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
PatchDeploymentName name = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]");
// Make the request
PatchDeployment response = await osConfigServiceClient.ResumePatchDeploymentAsync(name);

ResumePatchDeploymentAsync(PatchDeploymentName, CancellationToken)

public virtual Task<PatchDeployment> ResumePatchDeploymentAsync(PatchDeploymentName name, CancellationToken cancellationToken)

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

Parameters
NameDescription
namePatchDeploymentName

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
PatchDeploymentName name = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]");
// Make the request
PatchDeployment response = await osConfigServiceClient.ResumePatchDeploymentAsync(name);

ResumePatchDeploymentAsync(ResumePatchDeploymentRequest, CallSettings)

public virtual Task<PatchDeployment> ResumePatchDeploymentAsync(ResumePatchDeploymentRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestResumePatchDeploymentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
ResumePatchDeploymentRequest request = new ResumePatchDeploymentRequest
{
    PatchDeploymentName = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]"),
};
// Make the request
PatchDeployment response = await osConfigServiceClient.ResumePatchDeploymentAsync(request);

ResumePatchDeploymentAsync(ResumePatchDeploymentRequest, CancellationToken)

public virtual Task<PatchDeployment> ResumePatchDeploymentAsync(ResumePatchDeploymentRequest request, CancellationToken cancellationToken)

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

Parameters
NameDescription
requestResumePatchDeploymentRequest

The request object containing all of the parameters for the API call.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
ResumePatchDeploymentRequest request = new ResumePatchDeploymentRequest
{
    PatchDeploymentName = PatchDeploymentName.FromProjectPatchDeployment("[PROJECT]", "[PATCH_DEPLOYMENT]"),
};
// Make the request
PatchDeployment response = await osConfigServiceClient.ResumePatchDeploymentAsync(request);

ResumePatchDeploymentAsync(String, CallSettings)

public virtual Task<PatchDeployment> ResumePatchDeploymentAsync(string name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameString

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/patchDeployments/[PATCH_DEPLOYMENT]";
// Make the request
PatchDeployment response = await osConfigServiceClient.ResumePatchDeploymentAsync(name);

ResumePatchDeploymentAsync(String, CancellationToken)

public virtual Task<PatchDeployment> ResumePatchDeploymentAsync(string name, CancellationToken cancellationToken)

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

Parameters
NameDescription
nameString

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/patchDeployments/[PATCH_DEPLOYMENT]";
// Make the request
PatchDeployment response = await osConfigServiceClient.ResumePatchDeploymentAsync(name);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
TypeDescription
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdatePatchDeployment(PatchDeployment, FieldMask, CallSettings)

public virtual PatchDeployment UpdatePatchDeployment(PatchDeployment patchDeployment, FieldMask updateMask, CallSettings callSettings = null)

Update an OS Config patch deployment.

Parameters
NameDescription
patchDeploymentPatchDeployment

Required. The patch deployment to Update.

updateMaskFieldMask

Optional. Field mask that controls which fields of the patch deployment should be updated.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PatchDeployment

The RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
PatchDeployment patchDeployment = new PatchDeployment();
FieldMask updateMask = new FieldMask();
// Make the request
PatchDeployment response = osConfigServiceClient.UpdatePatchDeployment(patchDeployment, updateMask);

UpdatePatchDeployment(UpdatePatchDeploymentRequest, CallSettings)

public virtual PatchDeployment UpdatePatchDeployment(UpdatePatchDeploymentRequest request, CallSettings callSettings = null)

Update an OS Config patch deployment.

Parameters
NameDescription
requestUpdatePatchDeploymentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PatchDeployment

The RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = OsConfigServiceClient.Create();
// Initialize request argument(s)
UpdatePatchDeploymentRequest request = new UpdatePatchDeploymentRequest
{
    PatchDeployment = new PatchDeployment(),
    UpdateMask = new FieldMask(),
};
// Make the request
PatchDeployment response = osConfigServiceClient.UpdatePatchDeployment(request);

UpdatePatchDeploymentAsync(PatchDeployment, FieldMask, CallSettings)

public virtual Task<PatchDeployment> UpdatePatchDeploymentAsync(PatchDeployment patchDeployment, FieldMask updateMask, CallSettings callSettings = null)

Update an OS Config patch deployment.

Parameters
NameDescription
patchDeploymentPatchDeployment

Required. The patch deployment to Update.

updateMaskFieldMask

Optional. Field mask that controls which fields of the patch deployment should be updated.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
PatchDeployment patchDeployment = new PatchDeployment();
FieldMask updateMask = new FieldMask();
// Make the request
PatchDeployment response = await osConfigServiceClient.UpdatePatchDeploymentAsync(patchDeployment, updateMask);

UpdatePatchDeploymentAsync(PatchDeployment, FieldMask, CancellationToken)

public virtual Task<PatchDeployment> UpdatePatchDeploymentAsync(PatchDeployment patchDeployment, FieldMask updateMask, CancellationToken cancellationToken)

Update an OS Config patch deployment.

Parameters
NameDescription
patchDeploymentPatchDeployment

Required. The patch deployment to Update.

updateMaskFieldMask

Optional. Field mask that controls which fields of the patch deployment should be updated.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
PatchDeployment patchDeployment = new PatchDeployment();
FieldMask updateMask = new FieldMask();
// Make the request
PatchDeployment response = await osConfigServiceClient.UpdatePatchDeploymentAsync(patchDeployment, updateMask);

UpdatePatchDeploymentAsync(UpdatePatchDeploymentRequest, CallSettings)

public virtual Task<PatchDeployment> UpdatePatchDeploymentAsync(UpdatePatchDeploymentRequest request, CallSettings callSettings = null)

Update an OS Config patch deployment.

Parameters
NameDescription
requestUpdatePatchDeploymentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
UpdatePatchDeploymentRequest request = new UpdatePatchDeploymentRequest
{
    PatchDeployment = new PatchDeployment(),
    UpdateMask = new FieldMask(),
};
// Make the request
PatchDeployment response = await osConfigServiceClient.UpdatePatchDeploymentAsync(request);

UpdatePatchDeploymentAsync(UpdatePatchDeploymentRequest, CancellationToken)

public virtual Task<PatchDeployment> UpdatePatchDeploymentAsync(UpdatePatchDeploymentRequest request, CancellationToken cancellationToken)

Update an OS Config patch deployment.

Parameters
NameDescription
requestUpdatePatchDeploymentRequest

The request object containing all of the parameters for the API call.

cancellationTokenSystem.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
TypeDescription
Task<PatchDeployment>

A Task containing the RPC response.

Example
// Create client
OsConfigServiceClient osConfigServiceClient = await OsConfigServiceClient.CreateAsync();
// Initialize request argument(s)
UpdatePatchDeploymentRequest request = new UpdatePatchDeploymentRequest
{
    PatchDeployment = new PatchDeployment(),
    UpdateMask = new FieldMask(),
};
// Make the request
PatchDeployment response = await osConfigServiceClient.UpdatePatchDeploymentAsync(request);