google_api_network_management v0.3.1 GoogleApi.NetworkManagement.V1beta1.Api.Projects View Source
API calls for all endpoints tagged Projects
.
Link to this section Summary
Functions
Gets information about a location.
Creates a new Connectivity Test. After you create a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes.
Deletes a specific ConnectivityTest
.
Gets the details of a specific Connectivity Test.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists all Connectivity Tests owned by a project.
Updates the configuration of an existing ConnectivityTest
.
After you update a test, the reachability analysis is performed as part
of the long running operation, which completes when the analysis completes.
The Reachability state in the test resource is updated with the new result.
Rerun an existing ConnectivityTest
.
After the user triggers the rerun, the reachability analysis is performed
as part of the long running operation, which completes when the analysis
completes.
Sets the access control policy on the specified resource. Replaces any existing policy.
Returns permissions that a caller has on the specified resource.
If the resource does not exist, this will return an empty set of
permissions, not a NOT_FOUND
error.
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
.
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
.
Lists information about the supported locations for this service.
Link to this section Functions
networkmanagement_projects_locations_get(connection, name, optional_params \\ [], opts \\ [])
View Sourcenetworkmanagement_projects_locations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.NetworkManagement.V1beta1.Model.Location.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets information about a location.
Parameters
connection
(type:GoogleApi.NetworkManagement.V1beta1.Connection.t
) - Connection to servername
(type:String.t
) - Resource name for the 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").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.NetworkManagement.V1beta1.Model.Location{}}
on success{:error, info}
on failure
networkmanagement_projects_locations_global_connectivity_tests_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourcenetworkmanagement_projects_locations_global_connectivity_tests_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.NetworkManagement.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Creates a new Connectivity Test. After you create a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes.
If the endpoint specifications in ConnectivityTest
are invalid
(for example, containing non-existent resources in the network, or you
don't have read permissions to the network configurations of listed
projects), then the reachability result returns a value of UNKNOWN
.
If the endpoint specifications in ConnectivityTest
are
incomplete, the reachability result returns a value of
AMBIGUOUS
. For more information,
see the Connectivity Test documentation.
Parameters
connection
(type:GoogleApi.NetworkManagement.V1beta1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The parent resource of the Connectivity Test to create:`projects/{project_id}/locations/global`
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").:testId
(type:String.t
) - Required. The logical name of the Connectivity Test in your project with the following restrictions:- Must contain only lowercase letters, numbers, and hyphens.
- Must start with a letter.
- Must be between 1-40 characters.
- Must end with a number or a letter.
- Must be unique within the customer project
:body
(type:GoogleApi.NetworkManagement.V1beta1.Model.ConnectivityTest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.NetworkManagement.V1beta1.Model.Operation{}}
on success{:error, info}
on failure
networkmanagement_projects_locations_global_connectivity_tests_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourcenetworkmanagement_projects_locations_global_connectivity_tests_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.NetworkManagement.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Deletes a specific ConnectivityTest
.
Parameters
connection
(type:GoogleApi.NetworkManagement.V1beta1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Connectivity Test resource name using the form:`projects/{project_id}/locations/global/connectivityTests/{test_id}`
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.NetworkManagement.V1beta1.Model.Operation{}}
on success{:error, info}
on failure
networkmanagement_projects_locations_global_connectivity_tests_get(connection, name, optional_params \\ [], opts \\ [])
View Sourcenetworkmanagement_projects_locations_global_connectivity_tests_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.NetworkManagement.V1beta1.Model.ConnectivityTest.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets the details of a specific Connectivity Test.
Parameters
connection
(type:GoogleApi.NetworkManagement.V1beta1.Connection.t
) - Connection to servername
(type:String.t
) - Required.ConnectivityTest
resource name using the form:`projects/{project_id}/locations/global/connectivityTests/{test_id}`
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.NetworkManagement.V1beta1.Model.ConnectivityTest{}}
on success{:error, info}
on failure
networkmanagement_projects_locations_global_connectivity_tests_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View Sourcenetworkmanagement_projects_locations_global_connectivity_tests_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.NetworkManagement.V1beta1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
connection
(type:GoogleApi.NetworkManagement.V1beta1.Connection.t
) - Connection to serverresource
(type:String.t
) - REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.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").:"options.requestedPolicyVersion"
(type:integer()
) - Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.
Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.
To learn which resources support conditions in their IAM policies, see the IAM documentation.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.NetworkManagement.V1beta1.Model.Policy{}}
on success{:error, info}
on failure
networkmanagement_projects_locations_global_connectivity_tests_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourcenetworkmanagement_projects_locations_global_connectivity_tests_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.NetworkManagement.V1beta1.Model.ListConnectivityTestsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists all Connectivity Tests owned by a project.
Parameters
connection
(type:GoogleApi.NetworkManagement.V1beta1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The parent resource of the Connectivity Tests:`projects/{project_id}/locations/global`
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
) - Lists theConnectivityTests
that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form<field> <operator> <value>
where operators:<
,>
,<=
,>=
,!=
,=
,:
are supported (colon:
represents a HAS operator which is roughly synonymous with equality).can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples:
Filter by name: name = "projects/proj-1/locations/global/connectivityTests/test-1
Filter by labels:
- Resources that have a key called
foo
labels.foo:* - Resources that have a key called
foo
whose value isbar
labels.foo = bar
- Resources that have a key called
:orderBy
(type:String.t
) - Field to use to sort the list.:pageSize
(type:integer()
) - Number ofConnectivityTests
to return.:pageToken
(type:String.t
) - Page token from an earlier query, as returned innext_page_token
.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.NetworkManagement.V1beta1.Model.ListConnectivityTestsResponse{}}
on success{:error, info}
on failure
networkmanagement_projects_locations_global_connectivity_tests_patch(connection, name, optional_params \\ [], opts \\ [])
View Sourcenetworkmanagement_projects_locations_global_connectivity_tests_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.NetworkManagement.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates the configuration of an existing ConnectivityTest
.
After you update a test, the reachability analysis is performed as part
of the long running operation, which completes when the analysis completes.
The Reachability state in the test resource is updated with the new result.
If the endpoint specifications in ConnectivityTest
are invalid
(for example, they contain non-existent resources in the network, or the
user does not have read permissions to the network configurations of
listed projects), then the reachability result returns a value of
UNKNOWN
.
If the endpoint specifications in ConnectivityTest
are incomplete, the
reachability result returns a value of AMBIGUOUS
. See the documentation
in ConnectivityTest
for for more details.
Parameters
connection
(type:GoogleApi.NetworkManagement.V1beta1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Unique name of the resource using the form:`projects/{project_id}/locations/global/connectivityTests/{test}`
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. Mask of fields to update. At least one path must be supplied in this field.:body
(type:GoogleApi.NetworkManagement.V1beta1.Model.ConnectivityTest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.NetworkManagement.V1beta1.Model.Operation{}}
on success{:error, info}
on failure
networkmanagement_projects_locations_global_connectivity_tests_rerun(connection, name, optional_params \\ [], opts \\ [])
View Sourcenetworkmanagement_projects_locations_global_connectivity_tests_rerun( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.NetworkManagement.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Rerun an existing ConnectivityTest
.
After the user triggers the rerun, the reachability analysis is performed
as part of the long running operation, which completes when the analysis
completes.
Even though the test configuration remains the same, the reachability result may change due to underlying network configuration changes.
If the endpoint specifications in ConnectivityTest
become invalid (for
example, specified resources are deleted in the network, or you lost
read permissions to the network configurations of listed projects), then
the reachability result returns a value of UNKNOWN
.
Parameters
connection
(type:GoogleApi.NetworkManagement.V1beta1.Connection.t
) - Connection to servername
(type:String.t
) - Required. Connectivity Test resource name using the form:`projects/{project_id}/locations/global/connectivityTests/{test_id}`
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.NetworkManagement.V1beta1.Model.RerunConnectivityTestRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.NetworkManagement.V1beta1.Model.Operation{}}
on success{:error, info}
on failure
networkmanagement_projects_locations_global_connectivity_tests_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View Sourcenetworkmanagement_projects_locations_global_connectivity_tests_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.NetworkManagement.V1beta1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters
connection
(type:GoogleApi.NetworkManagement.V1beta1.Connection.t
) - Connection to serverresource
(type:String.t
) - REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.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.NetworkManagement.V1beta1.Model.SetIamPolicyRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.NetworkManagement.V1beta1.Model.Policy{}}
on success{:error, info}
on failure
networkmanagement_projects_locations_global_connectivity_tests_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
View Sourcenetworkmanagement_projects_locations_global_connectivity_tests_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.NetworkManagement.V1beta1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Returns permissions that a caller has on the specified resource.
If the resource does not exist, this will return an empty set of
permissions, not a NOT_FOUND
error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters
connection
(type:GoogleApi.NetworkManagement.V1beta1.Connection.t
) - Connection to serverresource
(type:String.t
) - REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.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.NetworkManagement.V1beta1.Model.TestIamPermissionsRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.NetworkManagement.V1beta1.Model.TestIamPermissionsResponse{}}
on success{:error, info}
on failure
networkmanagement_projects_locations_global_operations_cancel(connection, name, optional_params \\ [], opts \\ [])
View Sourcenetworkmanagement_projects_locations_global_operations_cancel( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.NetworkManagement.V1beta1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {: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.NetworkManagement.V1beta1.Connection.t
) - Connection to servername
(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.NetworkManagement.V1beta1.Model.CancelOperationRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.NetworkManagement.V1beta1.Model.Empty{}}
on success{:error, info}
on failure
networkmanagement_projects_locations_global_operations_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourcenetworkmanagement_projects_locations_global_operations_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.NetworkManagement.V1beta1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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.NetworkManagement.V1beta1.Connection.t
) - Connection to servername
(type:String.t
) - The name of the operation resource 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.NetworkManagement.V1beta1.Model.Empty{}}
on success{:error, info}
on failure
networkmanagement_projects_locations_global_operations_get(connection, name, optional_params \\ [], opts \\ [])
View Sourcenetworkmanagement_projects_locations_global_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.NetworkManagement.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {: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.NetworkManagement.V1beta1.Connection.t
) - Connection to servername
(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.NetworkManagement.V1beta1.Model.Operation{}}
on success{:error, info}
on failure
networkmanagement_projects_locations_global_operations_list(connection, name, optional_params \\ [], opts \\ [])
View Sourcenetworkmanagement_projects_locations_global_operations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.NetworkManagement.V1beta1.Model.ListOperationsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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.NetworkManagement.V1beta1.Connection.t
) - Connection to servername
(type:String.t
) - The name of the operation's parent 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").: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.NetworkManagement.V1beta1.Model.ListOperationsResponse{}}
on success{:error, info}
on failure
networkmanagement_projects_locations_list(connection, name, optional_params \\ [], opts \\ [])
View Sourcenetworkmanagement_projects_locations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.NetworkManagement.V1beta1.Model.ListLocationsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists information about the supported locations for this service.
Parameters
connection
(type:GoogleApi.NetworkManagement.V1beta1.Connection.t
) - Connection to servername
(type:String.t
) - 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
) - 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.NetworkManagement.V1beta1.Model.ListLocationsResponse{}}
on success{:error, info}
on failure