google_api_composer v0.10.0 GoogleApi.Composer.V1beta1.Api.Projects View Source
API calls for all endpoints tagged Projects
.
Link to this section Summary
Functions
Create a new environment.
Delete an environment.
Get an existing environment.
List environments.
Update an environment.
List ImageVersions for provided location.
Deletes a long-running operation. This method indicates that the client is
no longer interested in the operation result. It does not cancel the
operation. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
.
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.
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED
.
Link to this section Functions
composer_projects_locations_environments_create(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])
View Sourcecomposer_projects_locations_environments_create( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Composer.V1beta1.Model.Operation.t()} | {:error, Tesla.Env.t()}
Create a new environment.
Parameters
connection
(type:GoogleApi.Composer.V1beta1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofparent
. The parent must be of the form "projects/{projectId}/locations/{locationId}".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.Composer.V1beta1.Model.Environment.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Composer.V1beta1.Model.Operation{}}
on success{:error, info}
on failure
composer_projects_locations_environments_delete(connection, projects_id, locations_id, environments_id, optional_params \\ [], opts \\ [])
View Sourcecomposer_projects_locations_environments_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Composer.V1beta1.Model.Operation.t()} | {:error, Tesla.Env.t()}
Delete an environment.
Parameters
connection
(type:GoogleApi.Composer.V1beta1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. The environment to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.environments_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.Composer.V1beta1.Model.Operation{}}
on success{:error, info}
on failure
composer_projects_locations_environments_get(connection, projects_id, locations_id, environments_id, optional_params \\ [], opts \\ [])
View Sourcecomposer_projects_locations_environments_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Composer.V1beta1.Model.Environment.t()} | {:error, Tesla.Env.t()}
Get an existing environment.
Parameters
connection
(type:GoogleApi.Composer.V1beta1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. The resource name of the environment to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.environments_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.Composer.V1beta1.Model.Environment{}}
on success{:error, info}
on failure
composer_projects_locations_environments_list(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])
View Sourcecomposer_projects_locations_environments_list( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Composer.V1beta1.Model.ListEnvironmentsResponse.t()} | {:error, Tesla.Env.t()}
List environments.
Parameters
connection
(type:GoogleApi.Composer.V1beta1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofparent
. List environments in the given project and location, in the form: "projects/{projectId}/locations/{locationId}"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").:pageSize
(type:integer()
) - The maximum number of environments to return.:pageToken
(type:String.t
) - The next_page_token value returned from a previous List request, if any.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Composer.V1beta1.Model.ListEnvironmentsResponse{}}
on success{:error, info}
on failure
composer_projects_locations_environments_patch(connection, projects_id, locations_id, environments_id, optional_params \\ [], opts \\ [])
View Sourcecomposer_projects_locations_environments_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Composer.V1beta1.Model.Operation.t()} | {:error, Tesla.Env.t()}
Update an environment.
Parameters
connection
(type:GoogleApi.Composer.V1beta1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. The relative resource name of the environment to update, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"locations_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.environments_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").:updateMask
(type:String.t
) - Required. A comma-separated list of paths, relative toEnvironment
, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of argparse, theupdateMask
parameter would include the following twopaths
values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.argparse". The included patch environment would specify the scikit-learn version as follows:{ "config":{ "softwareConfig":{ "pypiPackages":{ "scikit-learn":"==0.19.0" } } } }
Note that in the above example, any existing PyPI packages other than scikit-learn and argparse will be unaffected.
Only one update type may be included in a single request's
updateMask
. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels "label1" and "label2" while clearing "label3" (assuming it already exists), one can provide the paths "labels.label1", "labels.label2", and "labels.label3" and populate the patch environment as follows:{ "labels":{ "label1":"new-label1-value" "label2":"new-label2-value" } }
Note that in the above example, any existing labels that are not included in the
updateMask
will be unaffected.It is also possible to replace an entire map field by providing the map field's path in the
updateMask
. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, theupdateMask
would contain the path "config.softwareConfig.pypiPackages", and the patch environment would be the following:{ "config":{ "softwareConfig":{ "pypiPackages":{ "botocore":"==1.7.14" } } } }
Note: Only the following fields can be updated:
Mask Purpose config.softwareConfig.pypiPackages Replace all custom custom PyPI packages. If a replacement package map is not included in environment
, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package.config.softwareConfig.pypiPackages.packagename Update the custom PyPI package packagename, preserving other packages. To delete the package, include it in updateMask
, and omit the mapping for it inenvironment.config.softwareConfig.pypiPackages
. It is an error to provide both a mask of this form and the "config.softwareConfig.pypiPackages" mask.labels Replace all environment labels. If a replacement labels map is not included in environment
, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels.labels.labelName Set the label named labelName, while preserving other labels. To delete the label, include it in updateMask
and omit its mapping inenvironment.labels
. It is an error to provide both a mask of this form and the "labels" mask.config.nodeCount Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the config.nodeCount
field.config.softwareConfig.airflowConfigOverrides Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in environment
, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides.config.softwareConfig.airflowConfigOverrides.section-name Override the Apache Airflow config property name in the section named section, preserving other properties. To delete the property override, include it in updateMask
and omit its mapping inenvironment.config.softwareConfig.airflowConfigOverrides
. It is an error to provide both a mask of this form and the "config.softwareConfig.airflowConfigOverrides" mask.config.softwareConfig.envVariables Replace all environment variables. If a replacement environment variable map is not included in environment
, all custom environment variables are cleared. It is an error to provide both this mask and a mask specifying one or more individual environment variables.config.softwareConfig.imageVersion Upgrade the version of the environment in-place. Refer to SoftwareConfig.image_version
for information on how to format the new image version. Additionally, the new image version cannot effect a version downgrade and must match the current image version's Composer major version and Airflow major and minor versions. Consult the Cloud Composer Version List for valid values.:body
(type:GoogleApi.Composer.V1beta1.Model.Environment.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Composer.V1beta1.Model.Operation{}}
on success{:error, info}
on failure
composer_projects_locations_image_versions_list(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])
View Sourcecomposer_projects_locations_image_versions_list( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Composer.V1beta1.Model.ListImageVersionsResponse.t()} | {:error, Tesla.Env.t()}
List ImageVersions for provided location.
Parameters
connection
(type:GoogleApi.Composer.V1beta1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofparent
. List ImageVersions in the given project and location, in the form: "projects/{projectId}/locations/{locationId}"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").:pageSize
(type:integer()
) - The maximum number of image_versions to return.:pageToken
(type:String.t
) - The next_page_token value returned from a previous List request, if any.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Composer.V1beta1.Model.ListImageVersionsResponse{}}
on success{:error, info}
on failure
composer_projects_locations_operations_delete(connection, projects_id, locations_id, operations_id, optional_params \\ [], opts \\ [])
View Sourcecomposer_projects_locations_operations_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Composer.V1beta1.Model.Empty.t()} | {:error, Tesla.Env.t()}
Deletes a long-running operation. This method indicates that the client is
no longer interested in the operation result. It does not cancel the
operation. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
.
Parameters
connection
(type:GoogleApi.Composer.V1beta1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. The name of the operation resource to be deleted.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.Composer.V1beta1.Model.Empty{}}
on success{:error, info}
on failure
composer_projects_locations_operations_get(connection, projects_id, locations_id, operations_id, optional_params \\ [], opts \\ [])
View Sourcecomposer_projects_locations_operations_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Composer.V1beta1.Model.Operation.t()} | {:error, Tesla.Env.t()}
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.Composer.V1beta1.Connection.t
) - Connection to serverprojects_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.Composer.V1beta1.Model.Operation{}}
on success{:error, info}
on failure
composer_projects_locations_operations_list(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])
View Sourcecomposer_projects_locations_operations_list( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Composer.V1beta1.Model.ListOperationsResponse.t()} | {:error, Tesla.Env.t()}
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding
to use different resource name schemes, such as users/*/operations
. To
override the binding, API services can add a binding such as
"/v1/{name=users/*}/operations"
to their service configuration.
For backwards compatibility, the default name includes the operations
collection id, however overriding users must ensure the name binding
is the parent resource, without the operations collection id.
Parameters
connection
(type:GoogleApi.Composer.V1beta1.Connection.t
) - Connection to serverprojects_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
) - The standard list filter.:pageSize
(type:integer()
) - The standard list page size.:pageToken
(type:String.t
) - The standard list page token.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Composer.V1beta1.Model.ListOperationsResponse{}}
on success{:error, info}
on failure