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

API calls for all endpoints tagged Projects.

Link to this section Summary

Link to this section Functions

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_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