• Home
• com.google.apis
• google-api-services-integrations
• v1alpha-rev20230117-2.0.0
• source code
• Integrations.Projects.Locations.IntegrationsOperations.Versions.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.integrations.v1alpha.Integrations.Projects.Locations.IntegrationsOperations.Versions.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.integrations.v1alpha
Class Integrations.Projects.Locations.IntegrationsOperations.Versions



java.lang.Object


com.google.api.services.integrations.v1alpha.Integrations.Projects.Locations.IntegrationsOperations.Versions







Enclosing class:
Integrations.Projects.Locations.IntegrationsOperations




public class Integrations.Projects.Locations.IntegrationsOperations.Versions
extends Object
The "versions" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Integrations.Projects.Locations.IntegrationsOperations.Versions.Archive 


class 
Integrations.Projects.Locations.IntegrationsOperations.Versions.Create 


class 
Integrations.Projects.Locations.IntegrationsOperations.Versions.Deactivate 


class 
Integrations.Projects.Locations.IntegrationsOperations.Versions.Delete 


class 
Integrations.Projects.Locations.IntegrationsOperations.Versions.Download 


class 
Integrations.Projects.Locations.IntegrationsOperations.Versions.Get 


class 
Integrations.Projects.Locations.IntegrationsOperations.Versions.List 


class 
Integrations.Projects.Locations.IntegrationsOperations.Versions.Patch 


class 
Integrations.Projects.Locations.IntegrationsOperations.Versions.Publish 


class 
Integrations.Projects.Locations.IntegrationsOperations.Versions.TakeoverEditLock 


class 
Integrations.Projects.Locations.IntegrationsOperations.Versions.Unpublish 


class 
Integrations.Projects.Locations.IntegrationsOperations.Versions.Upload 


class 
Integrations.Projects.Locations.IntegrationsOperations.Versions.Validate 









Constructor Summary

Constructors 

Constructor and Description


Versions() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Integrations.Projects.Locations.IntegrationsOperations.Versions.Archive
archive(String name,
       GoogleCloudIntegrationsV1alphaArchiveIntegrationVersionRequest content)
Soft-deletes the integration.



Integrations.Projects.Locations.IntegrationsOperations.Versions.Create
create(String parent,
      GoogleCloudIntegrationsV1alphaIntegrationVersion content)
Create a integration with a draft version in the specified project.



Integrations.Projects.Locations.IntegrationsOperations.Versions.Deactivate
deactivate(String name,
          GoogleCloudIntegrationsV1alphaDeactivateIntegrationVersionRequest content)
Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after
 validating it.



Integrations.Projects.Locations.IntegrationsOperations.Versions.Delete
delete(String name)
Soft-deletes the integration.



Integrations.Projects.Locations.IntegrationsOperations.Versions.Download
download(String name)
Downloads an integration.



Integrations.Projects.Locations.IntegrationsOperations.Versions.Get
get(String name)
Get a integration in the specified project.



Integrations.Projects.Locations.IntegrationsOperations.Versions.List
list(String parent)
Returns the list of all integration versions in the specified project.



Integrations.Projects.Locations.IntegrationsOperations.Versions.Patch
patch(String name,
     GoogleCloudIntegrationsV1alphaIntegrationVersion content)
Update a integration with a draft version in the specified project.



Integrations.Projects.Locations.IntegrationsOperations.Versions.Publish
publish(String name,
       GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest content)
This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state.



Integrations.Projects.Locations.IntegrationsOperations.Versions.TakeoverEditLock
takeoverEditLock(String integrationVersion,
                GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest content)
Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of this integration.



Integrations.Projects.Locations.IntegrationsOperations.Versions.Unpublish
unpublish(String name,
         GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest content)
Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after
 validating it.



Integrations.Projects.Locations.IntegrationsOperations.Versions.Upload
upload(String parent,
      GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest content)
Uploads an integration.



Integrations.Projects.Locations.IntegrationsOperations.Versions.Validate
validate(String name,
        GoogleCloudIntegrationsV1alphaValidateIntegrationVersionRequest content)
Validates the given integration.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Versions
public Versions()









Method Detail





archive
public Integrations.Projects.Locations.IntegrationsOperations.Versions.Archive archive(String name,
                                                                                       GoogleCloudIntegrationsV1alphaArchiveIntegrationVersionRequest content)
                                                                                throws IOException
Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the
 integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to
 the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too.
 This RPC throws an exception if the version being archived is DRAFT, and if the `locked_by` user
 is not the same as the user performing the Archive. Audit fields updated include
 last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a
 integration. Currently, there is no unarchive mechanism.

 Create a request for the method "versions.archive".

 This request holds the parameters needed by the integrations server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The version to archive. Format:
        projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
content - the GoogleCloudIntegrationsV1alphaArchiveIntegrationVersionRequest
Returns:
the request
Throws:
IOException








create
public Integrations.Projects.Locations.IntegrationsOperations.Versions.Create create(String parent,
                                                                                     GoogleCloudIntegrationsV1alphaIntegrationVersion content)
                                                                              throws IOException
Create a integration with a draft version in the specified project.

 Create a request for the method "versions.create".

 This request holds the parameters needed by the integrations server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. The parent resource where this version will be created. Format:
        projects/{project}/locations/{location}/integrations/{integration}
content - the GoogleCloudIntegrationsV1alphaIntegrationVersion
Returns:
the request
Throws:
IOException








deactivate
public Integrations.Projects.Locations.IntegrationsOperations.Versions.Deactivate deactivate(String name,
                                                                                             GoogleCloudIntegrationsV1alphaDeactivateIntegrationVersionRequest content)
                                                                                      throws IOException
Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after
 validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an
 exception if the version being snapshot is not ACTIVE. Audit fields added include action,
 action_by, action_timestamp.

 Create a request for the method "versions.deactivate".

 This request holds the parameters needed by the integrations server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The version to deactivate. Format:
        projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
content - the GoogleCloudIntegrationsV1alphaDeactivateIntegrationVersionRequest
Returns:
the request
Throws:
IOException








delete
public Integrations.Projects.Locations.IntegrationsOperations.Versions.Delete delete(String name)
                                                                              throws IOException
Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the
 integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to
 the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too.
 This RPC throws an exception if the version being deleted is DRAFT, and if the `locked_by` user
 is not the same as the user performing the Delete. Audit fields updated include
 last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a
 integration. Currently, there is no undelete mechanism.

 Create a request for the method "versions.delete".

 This request holds the parameters needed by the integrations server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The version to delete. Format:
        projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Returns:
the request
Throws:
IOException








download
public Integrations.Projects.Locations.IntegrationsOperations.Versions.Download download(String name)
                                                                                  throws IOException
Downloads an integration. Retrieves the `IntegrationVersion` for a given `integration_id` and
 returns the response as a string.

 Create a request for the method "versions.download".

 This request holds the parameters needed by the integrations server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The version to download. Format:
        projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Returns:
the request
Throws:
IOException








get
public Integrations.Projects.Locations.IntegrationsOperations.Versions.Get get(String name)
                                                                        throws IOException
Get a integration in the specified project.

 Create a request for the method "versions.get".

 This request holds the parameters needed by the integrations server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The version to retrieve. Format:
        projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Returns:
the request
Throws:
IOException








list
public Integrations.Projects.Locations.IntegrationsOperations.Versions.List list(String parent)
                                                                          throws IOException
Returns the list of all integration versions in the specified project.

 Create a request for the method "versions.list".

 This request holds the parameters needed by the integrations server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. The parent resource where this version will be created. Format:
        projects/{project}/locations/{location}/integrations/{integration} Specifically, when
        parent equals: 1. projects//locations//integrations/, Meaning: "List versions (with
        filter) for a particular integration". 2. projects//locations//integrations/- Meaning:
        "List versions (with filter) for a client within a particular region". 3.
        projects//locations/-/integrations/- Meaning: "List versions (with filter) for a client".
Returns:
the request
Throws:
IOException








patch
public Integrations.Projects.Locations.IntegrationsOperations.Versions.Patch patch(String name,
                                                                                   GoogleCloudIntegrationsV1alphaIntegrationVersion content)
                                                                            throws IOException
Update a integration with a draft version in the specified project.

 Create a request for the method "versions.patch".

 This request holds the parameters needed by the integrations server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Output only. Auto-generated primary key.
content - the GoogleCloudIntegrationsV1alphaIntegrationVersion
Returns:
the request
Throws:
IOException








publish
public Integrations.Projects.Locations.IntegrationsOperations.Versions.Publish publish(String name,
                                                                                       GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest content)
                                                                                throws IOException
This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws
 an exception if the version being published is DRAFT, and if the `locked_by` user is not the same
 as the user performing the Publish. Audit fields updated include last_published_timestamp,
 last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this
 integration is released.

 Create a request for the method "versions.publish".

 This request holds the parameters needed by the integrations server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The version to publish. Format:
        projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
content - the GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest
Returns:
the request
Throws:
IOException








takeoverEditLock
public Integrations.Projects.Locations.IntegrationsOperations.Versions.TakeoverEditLock takeoverEditLock(String integrationVersion,
                                                                                                         GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest content)
                                                                                                  throws IOException
Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of this integration. It then
 performs the same action as the CreateDraftIntegrationVersion (i.e., copies the DRAFT version of
 the integration as a SNAPSHOT and then creates a new DRAFT version with the `locked_by` set to
 the `user_taking_over` and the `locked_at_timestamp` set to the current timestamp). Both the
 `locked_by` and `user_taking_over` are notified via email about the takeover. This RPC throws an
 exception if the integration is not in DRAFT status or if the `locked_by` and
 `locked_at_timestamp` fields are not set.The TakeoverEdit lock is treated the same as an edit of
 the integration, and hence shares ACLs with edit. Audit fields updated include
 last_modified_timestamp, last_modified_by.

 Create a request for the method "versions.takeoverEditLock".

 This request holds the parameters needed by the integrations server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
integrationVersion - Required. The version to take over edit lock. Format:
        projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
content - the GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest
Returns:
the request
Throws:
IOException








unpublish
public Integrations.Projects.Locations.IntegrationsOperations.Versions.Unpublish unpublish(String name,
                                                                                           GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest content)
                                                                                    throws IOException
Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after
 validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an
 exception if the version being snapshot is not ACTIVE. Audit fields added include action,
 action_by, action_timestamp.

 Create a request for the method "versions.unpublish".

 This request holds the parameters needed by the integrations server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The version to deactivate. Format:
        projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
content - the GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest
Returns:
the request
Throws:
IOException








upload
public Integrations.Projects.Locations.IntegrationsOperations.Versions.Upload upload(String parent,
                                                                                     GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest content)
                                                                              throws IOException
Uploads an integration. The content can be a previously downloaded integration. Performs the same
 function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the
 complete representation of the IntegrationVersion content.

 Create a request for the method "versions.upload".

 This request holds the parameters needed by the integrations server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. The version to upload. Format:
        projects/{project}/locations/{location}/integrations/{integration}
content - the GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest
Returns:
the request
Throws:
IOException








validate
public Integrations.Projects.Locations.IntegrationsOperations.Versions.Validate validate(String name,
                                                                                         GoogleCloudIntegrationsV1alphaValidateIntegrationVersionRequest content)
                                                                                  throws IOException
Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If
 validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is
 returned.

 Create a request for the method "versions.validate".

 This request holds the parameters needed by the integrations server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The version to validate. Format:
        projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
content - the GoogleCloudIntegrationsV1alphaValidateIntegrationVersionRequest
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2023 Google. All rights reserved.