View Source GoogleApi.OSConfig.V1.Api.Projects (google_api_os_config v0.20.0)

API calls for all endpoints tagged Projects.

Link to this section Summary

Functions

Get inventory data for the specified VM instance. If the VM has no associated inventory, the message NOT_FOUND is returned.

Get the OS policy asssignment report for the specified Compute Engine VM instance.

List OS policy asssignment reports for all Compute Engine VM instances in the specified zone.

Gets the vulnerability report for the specified VM instance. Only VMs with inventory data have vulnerability reports associated with them.

Create an OS policy assignment. This method also creates the first revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

Delete the OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted. For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

Retrieve an existing OS policy assignment. This method always returns the latest revision. In order to retrieve a previous revision of the assignment, also provide the revision ID in the name parameter.

List the OS policy assignments under the parent resource. For each OS policy assignment, the latest revision is returned.

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Update an existing OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

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

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

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

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

Link to this section Functions

Link to this function

osconfig_projects_locations_instances_inventories_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_locations_instances_inventories_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.Inventory.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get inventory data for the specified VM instance. If the VM has no associated inventory, the message NOT_FOUND is returned.

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. API resource name for inventory resource. Format: projects/{project}/locations/{location}/instances/{instance}/inventory For {project}, either project-number or project-id can be provided. For {instance}, either Compute Engine instance-id or instance-name can be provided.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :view (type: String.t) - Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.Inventory{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_locations_instances_inventories_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_locations_instances_inventories_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.ListInventoriesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List inventory data for all VM instances in the specified zone.

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent resource name. Format: projects/{project}/locations/{location}/instances/- For {project}, either project-number or project-id can be provided.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - If provided, this field specifies the criteria that must be met by a Inventory API resource to be included in the response.
    • :pageSize (type: integer()) - The maximum number of results to return.
    • :pageToken (type: String.t) - A pagination token returned from a previous call to ListInventories that indicates where this listing should continue from.
    • :view (type: String.t) - Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.ListInventoriesResponse{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_locations_instances_os_policy_assignments_reports_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_locations_instances_os_policy_assignments_reports_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.OSPolicyAssignmentReport.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get the OS policy asssignment report for the specified Compute Engine VM instance.

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. API resource name for OS policy assignment report. Format: /projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/report For {project}, either project-number or project-id can be provided. For {instance_id}, either Compute Engine instance-id or instance-name can be provided. For {assignment_id}, the OSPolicyAssignment id must be provided.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.OSPolicyAssignmentReport{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_locations_instances_os_policy_assignments_reports_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_locations_instances_os_policy_assignments_reports_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.ListOSPolicyAssignmentReportsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List OS policy asssignment reports for all Compute Engine VM instances in the specified zone.

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent resource name. Format: projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/reports For {project}, either project-number or project-id can be provided. For {instance}, either instance-name, instance-id, or - can be provided. If '-' is provided, the response will include OSPolicyAssignmentReports for all instances in the project/location. For {assignment}, either assignment-id or - can be provided. If '-' is provided, the response will include OSPolicyAssignmentReports for all OSPolicyAssignments in the project/location. Either {instance} or {assignment} must be -. For example: projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/-/reports returns all reports for the instance projects/{project}/locations/{location}/instances/-/osPolicyAssignments/{assignment-id}/reports returns all the reports for the given assignment across all instances. projects/{project}/locations/{location}/instances/-/osPolicyAssignments/-/reports returns all the reports for all assignments across all instances.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - If provided, this field specifies the criteria that must be met by the OSPolicyAssignmentReport API resource that is included in the response.
    • :pageSize (type: integer()) - The maximum number of results to return.
    • :pageToken (type: String.t) - A pagination token returned from a previous call to the ListOSPolicyAssignmentReports method that indicates where this listing should continue from.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.ListOSPolicyAssignmentReportsResponse{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_locations_instances_vulnerability_reports_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_locations_instances_vulnerability_reports_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.VulnerabilityReport.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the vulnerability report for the specified VM instance. Only VMs with inventory data have vulnerability reports associated with them.

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. API resource name for vulnerability resource. Format: projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport For {project}, either project-number or project-id can be provided. For {instance}, either Compute Engine instance-id or instance-name can be provided.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.VulnerabilityReport{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_locations_instances_vulnerability_reports_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_locations_instances_vulnerability_reports_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.ListVulnerabilityReportsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List vulnerability reports for all VM instances in the specified zone.

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent resource name. Format: projects/{project}/locations/{location}/instances/- For {project}, either project-number or project-id can be provided.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - If provided, this field specifies the criteria that must be met by a vulnerabilityReport API resource to be included in the response.
    • :pageSize (type: integer()) - The maximum number of results to return.
    • :pageToken (type: String.t) - A pagination token returned from a previous call to ListVulnerabilityReports that indicates where this listing should continue from.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.ListVulnerabilityReportsResponse{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_locations_os_policy_assignments_create(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_locations_os_policy_assignments_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Create an OS policy assignment. This method also creates the first revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent resource name in the form: projects/{project}/locations/{location}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :osPolicyAssignmentId (type: String.t) - Required. The logical name of the OS policy assignment in the project with the following restrictions: 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.
    • :body (type: GoogleApi.OSConfig.V1.Model.OSPolicyAssignment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_locations_os_policy_assignments_delete(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_locations_os_policy_assignments_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Delete the OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted. For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the OS policy assignment to be deleted
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_locations_os_policy_assignments_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_locations_os_policy_assignments_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.OSPolicyAssignment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieve an existing OS policy assignment. This method always returns the latest revision. In order to retrieve a previous revision of the assignment, also provide the revision ID in the name parameter.

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of OS policy assignment. Format: projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}@{revisionId}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.OSPolicyAssignment{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_locations_os_policy_assignments_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_locations_os_policy_assignments_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.ListOSPolicyAssignmentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List the OS policy assignments under the parent resource. For each OS policy assignment, the latest revision is returned.

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent resource name.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of assignments to return.
    • :pageToken (type: String.t) - A pagination token returned from a previous call to ListOSPolicyAssignments that indicates where this listing should continue from.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.ListOSPolicyAssignmentsResponse{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_locations_os_policy_assignments_list_revisions(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_locations_os_policy_assignments_list_revisions(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.ListOSPolicyAssignmentRevisionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List the OS policy assignment revisions for a given OS policy assignment.

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the OS policy assignment to list revisions for.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of revisions to return.
    • :pageToken (type: String.t) - A pagination token returned from a previous call to ListOSPolicyAssignmentRevisions that indicates where this listing should continue from.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.ListOSPolicyAssignmentRevisionsResponse{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_locations_os_policy_assignments_operations_cancel(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_locations_os_policy_assignments_operations_cancel(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • name (type: String.t) - The name of the operation resource to be cancelled.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.OSConfig.V1.Model.CancelOperationRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_locations_os_policy_assignments_operations_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_locations_os_policy_assignments_operations_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • name (type: String.t) - The name of the operation resource.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_locations_os_policy_assignments_patch(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_locations_os_policy_assignments_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update an existing OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • name (type: String.t) - Resource name. Format: projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id} This field is ignored when you create an OS policy assignment.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Optional. Field mask that controls which fields of the assignment should be updated.
    • :body (type: GoogleApi.OSConfig.V1.Model.OSPolicyAssignment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_patch_deployments_create(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_patch_deployments_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.PatchDeployment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Create an OS Config patch deployment.

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project to apply this patch deployment to in the form projects/*.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :patchDeploymentId (type: String.t) - 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.
    • :body (type: GoogleApi.OSConfig.V1.Model.PatchDeployment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.PatchDeployment{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_patch_deployments_delete(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_patch_deployments_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Delete an OS Config patch deployment.

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_patch_deployments_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_patch_deployments_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.PatchDeployment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get an OS Config patch deployment.

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.PatchDeployment{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_patch_deployments_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_patch_deployments_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.ListPatchDeploymentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get a page of OS Config patch deployments.

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The resource name of the parent in the form projects/*.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. The maximum number of patch deployments to return. Default is 100.
    • :pageToken (type: String.t) - Optional. A pagination token returned from a previous call to ListPatchDeployments that indicates where this listing should continue from.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.ListPatchDeploymentsResponse{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_patch_deployments_patch(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_patch_deployments_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.PatchDeployment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update an OS Config patch deployment.

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • name (type: String.t) - Unique name for the patch deployment resource in a project. The patch deployment name is in the form: projects/{project_id}/patchDeployments/{patch_deployment_id}. This field is ignored when you create a new patch deployment.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Optional. Field mask that controls which fields of the patch deployment should be updated.
    • :body (type: GoogleApi.OSConfig.V1.Model.PatchDeployment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.PatchDeployment{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_patch_deployments_pause(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_patch_deployments_pause(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.PatchDeployment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.OSConfig.V1.Model.PausePatchDeploymentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.PatchDeployment{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_patch_deployments_resume(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_patch_deployments_resume(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.PatchDeployment.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.OSConfig.V1.Model.ResumePatchDeploymentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.PatchDeployment{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_patch_jobs_cancel(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_patch_jobs_cancel(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.PatchJob.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the patch in the form projects/*/patchJobs/*
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.OSConfig.V1.Model.CancelPatchJobRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.PatchJob{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_patch_jobs_execute(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_patch_jobs_execute(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.PatchJob.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Patch VM instances by creating and running a patch job.

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project in which to run this patch in the form projects/*
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.OSConfig.V1.Model.ExecutePatchJobRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.PatchJob{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_patch_jobs_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_patch_jobs_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.PatchJob.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the patch in the form projects/*/patchJobs/*
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.PatchJob{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_patch_jobs_instance_details_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_patch_jobs_instance_details_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.ListPatchJobInstanceDetailsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent for the instances are in the form of projects/*/patchJobs/*.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - A filter expression that filters results listed in the response. This field supports filtering results by instance zone, name, state, or failure_reason.
    • :pageSize (type: integer()) - The maximum number of instance details records to return. Default is 100.
    • :pageToken (type: String.t) - A pagination token returned from a previous call that indicates where this listing should continue from.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.ListPatchJobInstanceDetailsResponse{}} on success
  • {:error, info} on failure
Link to this function

osconfig_projects_patch_jobs_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

osconfig_projects_patch_jobs_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSConfig.V1.Model.ListPatchJobsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get a list of patch jobs.

Parameters

  • connection (type: GoogleApi.OSConfig.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. In the form of projects/*
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - If provided, this field specifies the criteria that must be met by patch jobs to be included in the response. Currently, filtering is only available on the patch_deployment field.
    • :pageSize (type: integer()) - The maximum number of instance status to return.
    • :pageToken (type: String.t) - A pagination token returned from a previous call that indicates where this listing should continue from.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSConfig.V1.Model.ListPatchJobsResponse{}} on success
  • {:error, info} on failure