GoogleApi.ContainerAnalysis.V1alpha1.Api.Providers (google_api_container_analysis v0.14.0) View Source

API calls for all endpoints tagged Providers.

Link to this section Summary

Functions

Gets the access control policy for a note or an Occurrence resource. Requires containeranalysis.notes.setIamPolicy or containeranalysis.occurrences.setIamPolicy permission if the resource is a note or occurrence, respectively. Attempting to call this method on a resource without the required permission will result in a PERMISSION_DENIED error. Attempting to call this method on a non-existent resource will result in a NOT_FOUND error if the user has list permission on the project, or a PERMISSION_DENIED error otherwise. The resource takes the following formats: projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID} for occurrences and projects/{PROJECT_ID}/notes/{NOTE_ID} for notes

Lists Occurrences referencing the specified Note. Use this method to get all occurrences referencing your Note across all your customer projects.

Sets the access control policy on the specified Note or Occurrence. Requires containeranalysis.notes.setIamPolicy or containeranalysis.occurrences.setIamPolicy permission if the resource is a Note or an Occurrence, respectively. Attempting to call this method without these permissions will result in a PERMISSION_DENIEDerror. Attempting to call this method on a non-existent resource will result in aNOT_FOUNDerror if the user hascontaineranalysis.notes.listpermission on aNoteorcontaineranalysis.occurrences.liston anOccurrence, or aPERMISSION_DENIEDerror otherwise. The resource takes the following formats:projects/{projectid}/occurrences/{occurrenceid}for occurrences and projects/{projectid}/notes/{noteid} for notes ## Parameters *connection(*type:*GoogleApi.ContainerAnalysis.V1alpha1.Connection.t) - Connection to server *providers_id(*type:*String.t) - Part ofresource. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. *notes_id(*type:*String.t) - Part ofresource. See documentation ofprovidersId. *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.ContainerAnalysis.V1alpha1.Model.SetIamPolicyRequest.t) - *opts(*type:*keyword()) - Call options ## Returns *}on success *` on failure

Returns the permissions that a caller has on the specified note or occurrence resource. Requires list permission on the project (for example, "storage.objects.list" on the containing bucket for testing permission of an object). Attempting to call this method on a non-existent resource will result in a NOT_FOUND error if the user has list permission on the project, or a PERMISSION_DENIED error otherwise. The resource takes the following formats: projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID} for Occurrences and projects/{PROJECT_ID}/notes/{NOTE_ID} for Notes

Link to this section Functions

Link to this function

containeranalysis_providers_notes_create(connection, providers_id, optional_params \\ [], opts \\ [])

View Source

Specs

containeranalysis_providers_notes_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ContainerAnalysis.V1alpha1.Model.Note.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new Note.

Parameters

  • connection (type: GoogleApi.ContainerAnalysis.V1alpha1.Connection.t) - Connection to server
  • providers_id (type: String.t) - Part of name. The name of the project. Should be of the form "providers/{provider_id}". @Deprecated
  • 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").
    • :noteId (type: String.t) - The ID to use for this note.
    • :parent (type: String.t) - This field contains the project Id for example: "projects/{project_id}
    • :body (type: GoogleApi.ContainerAnalysis.V1alpha1.Model.Note.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContainerAnalysis.V1alpha1.Model.Note{}} on success
  • {:error, info} on failure
Link to this function

containeranalysis_providers_notes_delete(connection, providers_id, notes_id, optional_params \\ [], opts \\ [])

View Source

Specs

containeranalysis_providers_notes_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ContainerAnalysis.V1alpha1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the given Note from the system.

Parameters

  • connection (type: GoogleApi.ContainerAnalysis.V1alpha1.Connection.t) - Connection to server
  • providers_id (type: String.t) - Part of name. The name of the note in the form of "providers/{provider_id}/notes/{NOTE_ID}"
  • notes_id (type: String.t) - Part of name. See documentation of providersId.
  • 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.ContainerAnalysis.V1alpha1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

containeranalysis_providers_notes_get(connection, providers_id, notes_id, optional_params \\ [], opts \\ [])

View Source

Specs

containeranalysis_providers_notes_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ContainerAnalysis.V1alpha1.Model.Note.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the requested Note.

Parameters

  • connection (type: GoogleApi.ContainerAnalysis.V1alpha1.Connection.t) - Connection to server
  • providers_id (type: String.t) - Part of name. The name of the note in the form of "providers/{provider_id}/notes/{NOTE_ID}"
  • notes_id (type: String.t) - Part of name. See documentation of providersId.
  • 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.ContainerAnalysis.V1alpha1.Model.Note{}} on success
  • {:error, info} on failure
Link to this function

containeranalysis_providers_notes_get_iam_policy(connection, providers_id, notes_id, optional_params \\ [], opts \\ [])

View Source

Specs

containeranalysis_providers_notes_get_iam_policy(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ContainerAnalysis.V1alpha1.Model.Policy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the access control policy for a note or an Occurrence resource. Requires containeranalysis.notes.setIamPolicy or containeranalysis.occurrences.setIamPolicy permission if the resource is a note or occurrence, respectively. Attempting to call this method on a resource without the required permission will result in a PERMISSION_DENIED error. Attempting to call this method on a non-existent resource will result in a NOT_FOUND error if the user has list permission on the project, or a PERMISSION_DENIED error otherwise. The resource takes the following formats: projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID} for occurrences and projects/{PROJECT_ID}/notes/{NOTE_ID} for notes

Parameters

  • connection (type: GoogleApi.ContainerAnalysis.V1alpha1.Connection.t) - Connection to server
  • providers_id (type: String.t) - Part of resource. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • notes_id (type: String.t) - Part of resource. See documentation of providersId.
  • 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.ContainerAnalysis.V1alpha1.Model.GetIamPolicyRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContainerAnalysis.V1alpha1.Model.Policy{}} on success
  • {:error, info} on failure
Link to this function

containeranalysis_providers_notes_list(connection, providers_id, optional_params \\ [], opts \\ [])

View Source

Specs

containeranalysis_providers_notes_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ContainerAnalysis.V1alpha1.Model.ListNotesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all Notes for a given project.

Parameters

  • connection (type: GoogleApi.ContainerAnalysis.V1alpha1.Connection.t) - Connection to server
  • providers_id (type: String.t) - Part of name. The name field will contain the project Id for example: "providers/{provider_id} @Deprecated
  • 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) - The filter expression.
    • :pageSize (type: integer()) - Number of notes to return in the list.
    • :pageToken (type: String.t) - Token to provide to skip to a particular spot in the list.
    • :parent (type: String.t) - This field contains the project Id for example: "projects/{PROJECT_ID}".
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContainerAnalysis.V1alpha1.Model.ListNotesResponse{}} on success
  • {:error, info} on failure
Link to this function

containeranalysis_providers_notes_occurrences_list(connection, providers_id, notes_id, optional_params \\ [], opts \\ [])

View Source

Specs

containeranalysis_providers_notes_occurrences_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContainerAnalysis.V1alpha1.Model.ListNoteOccurrencesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists Occurrences referencing the specified Note. Use this method to get all occurrences referencing your Note across all your customer projects.

Parameters

  • connection (type: GoogleApi.ContainerAnalysis.V1alpha1.Connection.t) - Connection to server
  • providers_id (type: String.t) - Part of name. The name field will contain the note name for example: "provider/{provider_id}/notes/{note_id}"
  • notes_id (type: String.t) - Part of name. See documentation of providersId.
  • 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) - The filter expression.
    • :pageSize (type: integer()) - Number of notes to return in the list.
    • :pageToken (type: String.t) - Token to provide to skip to a particular spot in the list.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContainerAnalysis.V1alpha1.Model.ListNoteOccurrencesResponse{}} on success
  • {:error, info} on failure
Link to this function

containeranalysis_providers_notes_patch(connection, providers_id, notes_id, optional_params \\ [], opts \\ [])

View Source

Specs

containeranalysis_providers_notes_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ContainerAnalysis.V1alpha1.Model.Note.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing Note.

Parameters

  • connection (type: GoogleApi.ContainerAnalysis.V1alpha1.Connection.t) - Connection to server
  • providers_id (type: String.t) - Part of name. The name of the note. Should be of the form "projects/{provider_id}/notes/{note_id}".
  • notes_id (type: String.t) - Part of name. See documentation of providersId.
  • 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) - The fields to update.
    • :body (type: GoogleApi.ContainerAnalysis.V1alpha1.Model.Note.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContainerAnalysis.V1alpha1.Model.Note{}} on success
  • {:error, info} on failure
Link to this function

containeranalysis_providers_notes_set_iam_policy(connection, providers_id, notes_id, optional_params \\ [], opts \\ [])

View Source

Specs

containeranalysis_providers_notes_set_iam_policy(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ContainerAnalysis.V1alpha1.Model.Policy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Sets the access control policy on the specified Note or Occurrence. Requires containeranalysis.notes.setIamPolicy or containeranalysis.occurrences.setIamPolicy permission if the resource is a Note or an Occurrence, respectively. Attempting to call this method without these permissions will result in a PERMISSION_DENIEDerror. Attempting to call this method on a non-existent resource will result in aNOT_FOUNDerror if the user hascontaineranalysis.notes.listpermission on aNoteorcontaineranalysis.occurrences.liston anOccurrence, or aPERMISSION_DENIEDerror otherwise. The resource takes the following formats:projects/{projectid}/occurrences/{occurrenceid}for occurrences and projects/{projectid}/notes/{noteid} for notes ## Parameters *connection(*type:*GoogleApi.ContainerAnalysis.V1alpha1.Connection.t) - Connection to server *providers_id(*type:*String.t) - Part ofresource. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. *notes_id(*type:*String.t) - Part ofresource. See documentation ofprovidersId. *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.ContainerAnalysis.V1alpha1.Model.SetIamPolicyRequest.t) - *opts(*type:*keyword()) - Call options ## Returns *}on success *` on failure

Link to this function

containeranalysis_providers_notes_test_iam_permissions(connection, providers_id, notes_id, optional_params \\ [], opts \\ [])

View Source

Specs

containeranalysis_providers_notes_test_iam_permissions(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.ContainerAnalysis.V1alpha1.Model.TestIamPermissionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the permissions that a caller has on the specified note or occurrence resource. Requires list permission on the project (for example, "storage.objects.list" on the containing bucket for testing permission of an object). Attempting to call this method on a non-existent resource will result in a NOT_FOUND error if the user has list permission on the project, or a PERMISSION_DENIED error otherwise. The resource takes the following formats: projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID} for Occurrences and projects/{PROJECT_ID}/notes/{NOTE_ID} for Notes

Parameters

  • connection (type: GoogleApi.ContainerAnalysis.V1alpha1.Connection.t) - Connection to server
  • providers_id (type: String.t) - Part of resource. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
  • notes_id (type: String.t) - Part of resource. See documentation of providersId.
  • 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.ContainerAnalysis.V1alpha1.Model.TestIamPermissionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ContainerAnalysis.V1alpha1.Model.TestIamPermissionsResponse{}} on success
  • {:error, info} on failure