View Source GoogleApi.LifeSciences.V2beta.Api.Projects (google_api_life_sciences v0.13.1)
API calls for all endpoints tagged Projects
.
Summary
Functions
Gets information about a location.
Lists information about the supported locations for this service.
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following Google IAM permission: * lifesciences.operations.cancel
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. Authorization requires the following Google IAM permission: * lifesciences.operations.get
Lists operations that match the specified filter in the request. Authorization requires the following Google IAM permission: * lifesciences.operations.list
Runs a pipeline. The returned Operation's metadata field will contain a google.cloud.lifesciences.v2beta.Metadata object describing the status of the pipeline execution. The response field will contain a google.cloud.lifesciences.v2beta.RunPipelineResponse object if the pipeline completes successfully. Note: Before you can use this method, the Life Sciences Service Agent must have access to your project. This is done automatically when the Cloud Life Sciences API is first enabled, but if you delete this permission you must disable and re-enable the API to grant the Life Sciences Service Agent the required permissions. Authorization requires the following Google IAM permission: * lifesciences.workflows.run
Functions
lifesciences_projects_locations_get(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])
View Source@spec lifesciences_projects_locations_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.LifeSciences.V2beta.Model.Location.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets information about a location.
Parameters
-
connection
(type:GoogleApi.LifeSciences.V2beta.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Resource name for the location. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
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.LifeSciences.V2beta.Model.Location{}}
on success -
{:error, info}
on failure
lifesciences_projects_locations_list(connection, projects_id, optional_params \\ [], opts \\ [])
View Source@spec lifesciences_projects_locations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.LifeSciences.V2beta.Model.ListLocationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists information about the supported locations for this service.
Parameters
-
connection
(type:GoogleApi.LifeSciences.V2beta.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. The resource that owns the locations collection, if applicable. -
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 to narrow down results to a preferred subset. The filtering language accepts strings like"displayName=tokyo"
, and is documented in more detail in AIP-160. -
:pageSize
(type:integer()
) - The maximum number of results to return. If not set, the service selects a default. -
:pageToken
(type:String.t
) - A page token received from thenext_page_token
field in the response. Send that page token to receive the subsequent page.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.LifeSciences.V2beta.Model.ListLocationsResponse{}}
on success -
{:error, info}
on failure
lifesciences_projects_locations_operations_cancel(connection, projects_id, locations_id, operations_id, optional_params \\ [], opts \\ [])
View Source@spec lifesciences_projects_locations_operations_cancel( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.LifeSciences.V2beta.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. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following Google IAM permission: * lifesciences.operations.cancel
Parameters
-
connection
(type:GoogleApi.LifeSciences.V2beta.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. The name of the operation resource to be cancelled. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
operations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
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.LifeSciences.V2beta.Model.CancelOperationRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.LifeSciences.V2beta.Model.Empty{}}
on success -
{:error, info}
on failure
lifesciences_projects_locations_operations_get(connection, projects_id, locations_id, operations_id, optional_params \\ [], opts \\ [])
View Source@spec lifesciences_projects_locations_operations_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.LifeSciences.V2beta.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. Authorization requires the following Google IAM permission: * lifesciences.operations.get
Parameters
-
connection
(type:GoogleApi.LifeSciences.V2beta.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. The name of the operation resource. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
operations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
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.LifeSciences.V2beta.Model.Operation{}}
on success -
{:error, info}
on failure
lifesciences_projects_locations_operations_list(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])
View Source@spec lifesciences_projects_locations_operations_list( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.LifeSciences.V2beta.Model.ListOperationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists operations that match the specified filter in the request. Authorization requires the following Google IAM permission: * lifesciences.operations.list
Parameters
-
connection
(type:GoogleApi.LifeSciences.V2beta.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. The name of the operation's parent resource. -
locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
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 string for filtering Operations. The following filter fields are supported: createTime: The time this job was created events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. -
:pageSize
(type:integer()
) - The maximum number of results to return. The maximum value is 256. -
:pageToken
(type:String.t
) - The standard list page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.LifeSciences.V2beta.Model.ListOperationsResponse{}}
on success -
{:error, info}
on failure
lifesciences_projects_locations_pipelines_run(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])
View Source@spec lifesciences_projects_locations_pipelines_run( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.LifeSciences.V2beta.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Runs a pipeline. The returned Operation's metadata field will contain a google.cloud.lifesciences.v2beta.Metadata object describing the status of the pipeline execution. The response field will contain a google.cloud.lifesciences.v2beta.RunPipelineResponse object if the pipeline completes successfully. Note: Before you can use this method, the Life Sciences Service Agent must have access to your project. This is done automatically when the Cloud Life Sciences API is first enabled, but if you delete this permission you must disable and re-enable the API to grant the Life Sciences Service Agent the required permissions. Authorization requires the following Google IAM permission: * lifesciences.workflows.run
Parameters
-
connection
(type:GoogleApi.LifeSciences.V2beta.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. The project and location that this request should be executed against. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
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.LifeSciences.V2beta.Model.RunPipelineRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.LifeSciences.V2beta.Model.Operation{}}
on success -
{:error, info}
on failure