Class: Google::Apis::IntegrationsV1alpha::IntegrationsService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/integrations_v1alpha/service.rb

Overview

Application Integration API

Examples:

require 'google/apis/integrations_v1alpha'

Integrations = Google::Apis::IntegrationsV1alpha # Alias the module
service = Integrations::IntegrationsService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeIntegrationsService

Returns a new instance of IntegrationsService.



45
46
47
48
49
50
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 45

def initialize
  super('https://integrations.googleapis.com/', '',
        client_name: 'google-apis-integrations_v1alpha',
        client_version: Google::Apis::IntegrationsV1alpha::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

Returns 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.

Returns:

  • (String)

    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.



38
39
40
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 38

def key
  @key
end

#quota_userString

Returns 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.

Returns:

  • (String)

    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.



43
44
45
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#cancel_project_location_product_integration_execution(name, google_cloud_integrations_v1alpha_cancel_execution_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCancelExecutionResponse

Cancellation of an execution

Parameters:

  • name (String)

    Required. The execution resource name. Format: projects/gcp_project_id/ locations/location/products/product/integrations/integration_id/ executions/execution_id

  • google_cloud_integrations_v1alpha_cancel_execution_request_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCancelExecutionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2070

def cancel_project_location_product_integration_execution(name, google_cloud_integrations_v1alpha_cancel_execution_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:cancel', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCancelExecutionRequest::Representation
  command.request_object = google_cloud_integrations_v1alpha_cancel_execution_request_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCancelExecutionResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCancelExecutionResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_apps_script_project(parent, google_cloud_integrations_v1alpha_create_apps_script_project_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse

Creates an Apps Script project.

Parameters:

  • parent (String)

    Required. The project that the executed integration belongs to.

  • google_cloud_integrations_v1alpha_create_apps_script_project_request_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



144
145
146
147
148
149
150
151
152
153
154
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 144

def create_project_location_apps_script_project(parent, google_cloud_integrations_v1alpha_create_apps_script_project_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/appsScriptProjects', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest::Representation
  command.request_object = google_cloud_integrations_v1alpha_create_apps_script_project_request_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_auth_config(parent, google_cloud_integrations_v1alpha_auth_config_object = nil, client_certificate_encrypted_private_key: nil, client_certificate_passphrase: nil, client_certificate_ssl_certificate: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig

Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.

Parameters:

  • parent (String)

    Required. "projects/project/locations/location" format.

  • google_cloud_integrations_v1alpha_auth_config_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig) (defaults to: nil)
  • client_certificate_encrypted_private_key (String) (defaults to: nil)

    The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/ sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/ BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----

  • client_certificate_passphrase (String) (defaults to: nil)

    'passphrase' should be left unset if private key is not encrypted. Note that ' passphrase' is not the password for web server, but an extra layer of security to protected private key.

  • client_certificate_ssl_certificate (String) (defaults to: nil)

    The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/ sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/ BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



249
250
251
252
253
254
255
256
257
258
259
260
261
262
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 249

def create_project_location_auth_config(parent, google_cloud_integrations_v1alpha_auth_config_object = nil, client_certificate_encrypted_private_key: nil, client_certificate_passphrase: nil, client_certificate_ssl_certificate: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/authConfigs', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig::Representation
  command.request_object = google_cloud_integrations_v1alpha_auth_config_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig
  command.params['parent'] = parent unless parent.nil?
  command.query['clientCertificate.encryptedPrivateKey'] = client_certificate_encrypted_private_key unless client_certificate_encrypted_private_key.nil?
  command.query['clientCertificate.passphrase'] = client_certificate_passphrase unless client_certificate_passphrase.nil?
  command.query['clientCertificate.sslCertificate'] = client_certificate_ssl_certificate unless client_certificate_ssl_certificate.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_integration_version(parent, google_cloud_integrations_v1alpha_integration_version_object = nil, new_integration: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion

Create a integration with a draft version in the specified project.

Parameters:

  • parent (String)

    Required. The parent resource where this version will be created. Format: projects/project/locations/location/integrations/integration

  • google_cloud_integrations_v1alpha_integration_version_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion) (defaults to: nil)
  • new_integration (Boolean) (defaults to: nil)

    Set this flag to true, if draft version is to be created for a brand new integration. False, if the request is for an existing integration. For backward compatibility reasons, even if this flag is set to false and no existing integration is found, a new draft integration will still be created.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1076

def create_project_location_integration_version(parent, google_cloud_integrations_v1alpha_integration_version_object = nil, new_integration: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/versions', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion::Representation
  command.request_object = google_cloud_integrations_v1alpha_integration_version_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion
  command.params['parent'] = parent unless parent.nil?
  command.query['newIntegration'] = new_integration unless new_integration.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_product_auth_config(parent, google_cloud_integrations_v1alpha_auth_config_object = nil, client_certificate_encrypted_private_key: nil, client_certificate_passphrase: nil, client_certificate_ssl_certificate: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig

Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.

Parameters:

  • parent (String)

    Required. "projects/project/locations/location" format.

  • google_cloud_integrations_v1alpha_auth_config_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig) (defaults to: nil)
  • client_certificate_encrypted_private_key (String) (defaults to: nil)

    The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/ sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/ BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----

  • client_certificate_passphrase (String) (defaults to: nil)

    'passphrase' should be left unset if private key is not encrypted. Note that ' passphrase' is not the password for web server, but an extra layer of security to protected private key.

  • client_certificate_ssl_certificate (String) (defaults to: nil)

    The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/ sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/ BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1512

def create_project_location_product_auth_config(parent, google_cloud_integrations_v1alpha_auth_config_object = nil, client_certificate_encrypted_private_key: nil, client_certificate_passphrase: nil, client_certificate_ssl_certificate: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/authConfigs', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig::Representation
  command.request_object = google_cloud_integrations_v1alpha_auth_config_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig
  command.params['parent'] = parent unless parent.nil?
  command.query['clientCertificate.encryptedPrivateKey'] = client_certificate_encrypted_private_key unless client_certificate_encrypted_private_key.nil?
  command.query['clientCertificate.passphrase'] = client_certificate_passphrase unless client_certificate_passphrase.nil?
  command.query['clientCertificate.sslCertificate'] = client_certificate_ssl_certificate unless client_certificate_ssl_certificate.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_product_certificate(parent, google_cloud_integrations_v1alpha_certificate_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCertificate

Creates a new certificate. The certificate will be registered to the trawler service and will be encrypted using cloud KMS and stored in Spanner Returns the certificate.

Parameters:

  • parent (String)

    Required. "projects/project/locations/location" format.

  • google_cloud_integrations_v1alpha_certificate_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCertificate) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1736

def create_project_location_product_certificate(parent, google_cloud_integrations_v1alpha_certificate_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/certificates', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCertificate::Representation
  command.request_object = google_cloud_integrations_v1alpha_certificate_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCertificate::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCertificate
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_product_integration_version(parent, google_cloud_integrations_v1alpha_integration_version_object = nil, new_integration: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion

Create a integration with a draft version in the specified project.

Parameters:

  • parent (String)

    Required. The parent resource where this version will be created. Format: projects/project/locations/location/integrations/integration

  • google_cloud_integrations_v1alpha_integration_version_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion) (defaults to: nil)
  • new_integration (Boolean) (defaults to: nil)

    Set this flag to true, if draft version is to be created for a brand new integration. False, if the request is for an existing integration. For backward compatibility reasons, even if this flag is set to false and no existing integration is found, a new draft integration will still be created.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2364

def create_project_location_product_integration_version(parent, google_cloud_integrations_v1alpha_integration_version_object = nil, new_integration: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/versions', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion::Representation
  command.request_object = google_cloud_integrations_v1alpha_integration_version_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion
  command.params['parent'] = parent unless parent.nil?
  command.query['newIntegration'] = new_integration unless new_integration.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_product_integrationtemplate_version(parent, google_cloud_integrations_v1alpha_integration_template_version_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationTemplateVersion

Creates an IntegrationTemplateVersion.

Parameters:

  • parent (String)

    Required. The parent resource where this TemplateVersion will be created. Format: projects/project/location/location/product/product/ integrationtemplates/integrationtemplate

  • google_cloud_integrations_v1alpha_integration_template_version_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationTemplateVersion) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2763

def create_project_location_product_integrationtemplate_version(parent, google_cloud_integrations_v1alpha_integration_template_version_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/versions', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationTemplateVersion::Representation
  command.request_object = google_cloud_integrations_v1alpha_integration_template_version_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationTemplateVersion::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationTemplateVersion
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_product_sfdc_instance(parent, google_cloud_integrations_v1alpha_sfdc_instance_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance

Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.

Parameters:

  • parent (String)

    Required. "projects/project/locations/location" format.

  • google_cloud_integrations_v1alpha_sfdc_instance_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2874

def create_project_location_product_sfdc_instance(parent, google_cloud_integrations_v1alpha_sfdc_instance_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/sfdcInstances', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance::Representation
  command.request_object = google_cloud_integrations_v1alpha_sfdc_instance_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_product_sfdc_instance_sfdc_channel(parent, google_cloud_integrations_v1alpha_sfdc_channel_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel

Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.

Parameters:

  • parent (String)

    Required. "projects/project/locations/location" format.

  • google_cloud_integrations_v1alpha_sfdc_channel_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 3053

def create_project_location_product_sfdc_instance_sfdc_channel(parent, google_cloud_integrations_v1alpha_sfdc_channel_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/sfdcChannels', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel::Representation
  command.request_object = google_cloud_integrations_v1alpha_sfdc_channel_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_sfdc_instance(parent, google_cloud_integrations_v1alpha_sfdc_instance_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance

Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.

Parameters:

  • parent (String)

    Required. "projects/project/locations/location" format.

  • google_cloud_integrations_v1alpha_sfdc_instance_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 3232

def create_project_location_sfdc_instance(parent, google_cloud_integrations_v1alpha_sfdc_instance_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/sfdcInstances', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance::Representation
  command.request_object = google_cloud_integrations_v1alpha_sfdc_instance_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_sfdc_instance_sfdc_channel(parent, google_cloud_integrations_v1alpha_sfdc_channel_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel

Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.

Parameters:

  • parent (String)

    Required. "projects/project/locations/location" format.

  • google_cloud_integrations_v1alpha_sfdc_channel_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 3411

def create_project_location_sfdc_instance_sfdc_channel(parent, google_cloud_integrations_v1alpha_sfdc_channel_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/sfdcChannels', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel::Representation
  command.request_object = google_cloud_integrations_v1alpha_sfdc_channel_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_auth_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty

Deletes an auth config.

Parameters:

  • name (String)

    Required. The name that is associated with the AuthConfig.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



284
285
286
287
288
289
290
291
292
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 284

def delete_project_location_auth_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_integration(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty

Delete the selected integration and all versions inside

Parameters:

  • name (String)

    Required. The location resource of the request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



657
658
659
660
661
662
663
664
665
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 657

def delete_project_location_integration(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_integration_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty

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.

Parameters:

  • name (String)

    Required. The version to delete. Format: projects/project/locations/ location/integrations/integration/versions/version

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1118
1119
1120
1121
1122
1123
1124
1125
1126
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1118

def delete_project_location_integration_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_product_auth_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty

Deletes an auth config.

Parameters:

  • name (String)

    Required. The name that is associated with the AuthConfig.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1547
1548
1549
1550
1551
1552
1553
1554
1555
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1547

def delete_project_location_product_auth_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_product_certificate(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty

Delete a certificate

Parameters:

  • name (String)

    Required. The name that is associated with the Certificate.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1768
1769
1770
1771
1772
1773
1774
1775
1776
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1768

def delete_project_location_product_certificate(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_product_integration(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty

Delete the selected integration and all versions inside

Parameters:

  • name (String)

    Required. The location resource of the request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1914
1915
1916
1917
1918
1919
1920
1921
1922
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1914

def delete_project_location_product_integration(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_product_integration_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty

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.

Parameters:

  • name (String)

    Required. The version to delete. Format: projects/project/locations/ location/integrations/integration/versions/version

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2406
2407
2408
2409
2410
2411
2412
2413
2414
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2406

def delete_project_location_product_integration_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_product_sfdc_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty

Deletes an sfdc instance.

Parameters:

  • name (String)

    Required. The name that is associated with the SfdcInstance.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2906
2907
2908
2909
2910
2911
2912
2913
2914
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2906

def delete_project_location_product_sfdc_instance(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_product_sfdc_instance_sfdc_channel(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty

Deletes an sfdc channel.

Parameters:

  • name (String)

    Required. The name that is associated with the SfdcChannel.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3085
3086
3087
3088
3089
3090
3091
3092
3093
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 3085

def delete_project_location_product_sfdc_instance_sfdc_channel(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_sfdc_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty

Deletes an sfdc instance.

Parameters:

  • name (String)

    Required. The name that is associated with the SfdcInstance.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3264
3265
3266
3267
3268
3269
3270
3271
3272
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 3264

def delete_project_location_sfdc_instance(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_sfdc_instance_sfdc_channel(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty

Deletes an sfdc channel.

Parameters:

  • name (String)

    Required. The name that is associated with the SfdcChannel.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3443
3444
3445
3446
3447
3448
3449
3450
3451
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 3443

def delete_project_location_sfdc_instance_sfdc_channel(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#download_project_location_integration_version(name, file_format: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse

Downloads an integration. Retrieves the IntegrationVersion for a given integration_id and returns the response as a string.

Parameters:

  • name (String)

    Required. The version to download. Format: projects/project/locations/ location/integrations/integration/versions/version

  • file_format (String) (defaults to: nil)

    File format for download request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1152

def download_project_location_integration_version(name, file_format: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}:download', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse
  command.params['name'] = name unless name.nil?
  command.query['fileFormat'] = file_format unless file_format.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#download_project_location_product_integration_version(name, file_format: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse

Downloads an integration. Retrieves the IntegrationVersion for a given integration_id and returns the response as a string.

Parameters:

  • name (String)

    Required. The version to download. Format: projects/project/locations/ location/integrations/integration/versions/version

  • file_format (String) (defaults to: nil)

    File format for download request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2440

def download_project_location_product_integration_version(name, file_format: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}:download', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse
  command.params['name'] = name unless name.nil?
  command.query['fileFormat'] = file_format unless file_format.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#enumerate_connector_platform_region(fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse

Enumerates the regions for which Connector Platform is provisioned.

Parameters:

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



114
115
116
117
118
119
120
121
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 114

def enumerate_connector_platform_region(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/connectorPlatformRegions:enumerate', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#execute_project_location_integration(name, google_cloud_integrations_v1alpha_execute_integrations_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse

Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified ( passing -), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given trigger_id is executed. This is helpful for execution the integration from UI.

Parameters:

  • name (String)

    Required. The integration resource name.

  • google_cloud_integrations_v1alpha_execute_integrations_request_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



693
694
695
696
697
698
699
700
701
702
703
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 693

def execute_project_location_integration(name, google_cloud_integrations_v1alpha_execute_integrations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:execute', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest::Representation
  command.request_object = google_cloud_integrations_v1alpha_execute_integrations_request_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#execute_project_location_integration_event(name, google_cloud_integrations_v1alpha_execute_event_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaExecuteEventResponse

Executes an integration on receiving events from Integration Connector triggers, Eventarc or CPS Trigger. The details about integration are derived from CloudEvent request body.

Parameters:

  • name (String)

    Required. The integration resource name. Format: projects/gcp_project_id/ locations/location/integrations/integration_id

  • google_cloud_integrations_v1alpha_execute_event_request_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaExecuteEventRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



729
730
731
732
733
734
735
736
737
738
739
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 729

def execute_project_location_integration_event(name, google_cloud_integrations_v1alpha_execute_event_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:executeEvent', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaExecuteEventRequest::Representation
  command.request_object = google_cloud_integrations_v1alpha_execute_event_request_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaExecuteEventResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaExecuteEventResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#execute_project_location_product_integration(name, google_cloud_integrations_v1alpha_execute_integrations_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse

Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified ( passing -), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given trigger_id is executed. This is helpful for execution the integration from UI.

Parameters:

  • name (String)

    Required. The integration resource name.

  • google_cloud_integrations_v1alpha_execute_integrations_request_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1950

def execute_project_location_product_integration(name, google_cloud_integrations_v1alpha_execute_integrations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:execute', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest::Representation
  command.request_object = google_cloud_integrations_v1alpha_execute_integrations_request_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_callback_token(code: nil, gcp_project_id: nil, product: nil, redirect_uri: nil, state: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaGenerateTokenResponse

Receives the auth code and auth config id to combine that with the client id and secret to retrieve access tokens from the token endpoint. Returns either a success or error message when it's done.

Parameters:

  • code (String) (defaults to: nil)

    The auth code for the given request

  • gcp_project_id (String) (defaults to: nil)

    The gcp project id of the request

  • product (String) (defaults to: nil)

    Which product sends the request

  • redirect_uri (String) (defaults to: nil)

    Redirect uri of the auth code request

  • state (String) (defaults to: nil)

    The auth config id for the given request

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 82

def generate_callback_token(code: nil, gcp_project_id: nil, product: nil, redirect_uri: nil, state: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/callback:generateToken', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaGenerateTokenResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaGenerateTokenResponse
  command.query['code'] = code unless code.nil?
  command.query['gcpProjectId'] = gcp_project_id unless gcp_project_id.nil?
  command.query['product'] = product unless product.nil?
  command.query['redirectUri'] = redirect_uri unless redirect_uri.nil?
  command.query['state'] = state unless state.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_auth_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig

Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.

Parameters:

  • name (String)

    Required. The name that is associated with the AuthConfig.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



315
316
317
318
319
320
321
322
323
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 315

def get_project_location_auth_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_certificate(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCertificate

Get a certificates in the specified project.

Parameters:

  • name (String)

    Required. The certificate to retrieve. Format: projects/project/locations/ location/certificates/certificate

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



471
472
473
474
475
476
477
478
479
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 471

def get_project_location_certificate(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCertificate::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCertificate
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_connection_connection_schema_metadata(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata

Lists the available entities and actions associated with a Connection.

Parameters:

  • name (String)

    Required. ConnectionSchemaMetadata name. Format: projects/project/locations/ location/connections/connection/connectionSchemaMetadata

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



502
503
504
505
506
507
508
509
510
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 502

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_integration_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion

Get a integration in the specified project.

Parameters:

  • name (String)

    Required. The version to retrieve. Format: projects/project/locations/ location/integrations/integration/versions/version

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1184
1185
1186
1187
1188
1189
1190
1191
1192
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1184

def get_project_location_integration_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_product_auth_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig

Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.

Parameters:

  • name (String)

    Required. The name that is associated with the AuthConfig.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1578
1579
1580
1581
1582
1583
1584
1585
1586
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1578

def get_project_location_product_auth_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_product_certificate(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCertificate

Get a certificates in the specified project.

Parameters:

  • name (String)

    Required. The certificate to retrieve. Format: projects/project/locations/ location/certificates/certificate

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1799
1800
1801
1802
1803
1804
1805
1806
1807
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1799

def get_project_location_product_certificate(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCertificate::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCertificate
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_product_integration_execution(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaExecution

Get an execution in the specified project.

Parameters:

  • name (String)

    Required. The execution resource name. Format: projects/gcp_project_id/ locations/location/products/product/integrations/integration_id/ executions/execution_id

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2104
2105
2106
2107
2108
2109
2110
2111
2112
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2104

def get_project_location_product_integration_execution(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaExecution::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaExecution
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_product_integration_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion

Get a integration in the specified project.

Parameters:

  • name (String)

    Required. The version to retrieve. Format: projects/project/locations/ location/integrations/integration/versions/version

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2472
2473
2474
2475
2476
2477
2478
2479
2480
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2472

def get_project_location_product_integration_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_product_integrationtemplate_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationTemplateVersion

Returns an IntegrationTemplateVersion in the specified project.

Parameters:

  • name (String)

    Required. The TemplateVersion to retrieve. Format: projects/project/ locations/location/products/product/integrationtemplates/ integrationtemplate/versions/version

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2797
2798
2799
2800
2801
2802
2803
2804
2805
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2797

def get_project_location_product_integrationtemplate_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationTemplateVersion::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationTemplateVersion
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_product_sfdc_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance

Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.

Parameters:

  • name (String)

    Required. The name that is associated with the SfdcInstance.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2937
2938
2939
2940
2941
2942
2943
2944
2945
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2937

def get_project_location_product_sfdc_instance(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_product_sfdc_instance_sfdc_channel(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel

Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.

Parameters:

  • name (String)

    Required. The name that is associated with the SfdcChannel.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3116
3117
3118
3119
3120
3121
3122
3123
3124
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 3116

def get_project_location_product_sfdc_instance_sfdc_channel(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_sfdc_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance

Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.

Parameters:

  • name (String)

    Required. The name that is associated with the SfdcInstance.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3295
3296
3297
3298
3299
3300
3301
3302
3303
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 3295

def get_project_location_sfdc_instance(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_sfdc_instance_sfdc_channel(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel

Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.

Parameters:

  • name (String)

    Required. The name that is associated with the SfdcChannel.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 3474

def get_project_location_sfdc_instance_sfdc_channel(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#lift_project_location_integration_execution_suspension(name, google_cloud_integrations_v1alpha_lift_suspension_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaLiftSuspensionResponse

  • Lifts suspension for advanced suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.

Parameters:

  • name (String)

    Required. The resource that the suspension belongs to. "projects/project/ locations/location/products/product/integrations/integration/executions/ execution/suspensions/suspenion" format.

  • google_cloud_integrations_v1alpha_lift_suspension_request_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaLiftSuspensionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



956
957
958
959
960
961
962
963
964
965
966
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 956

def lift_project_location_integration_execution_suspension(name, google_cloud_integrations_v1alpha_lift_suspension_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:lift', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaLiftSuspensionRequest::Representation
  command.request_object = google_cloud_integrations_v1alpha_lift_suspension_request_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaLiftSuspensionResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaLiftSuspensionResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#lift_project_location_product_integration_execution_suspension(name, google_cloud_integrations_v1alpha_lift_suspension_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaLiftSuspensionResponse

  • Lifts suspension for advanced suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.

Parameters:

  • name (String)

    Required. The resource that the suspension belongs to. "projects/project/ locations/location/products/product/integrations/integration/executions/ execution/suspensions/suspenion" format.

  • google_cloud_integrations_v1alpha_lift_suspension_request_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaLiftSuspensionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2244

def lift_project_location_product_integration_execution_suspension(name, google_cloud_integrations_v1alpha_lift_suspension_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:lift', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaLiftSuspensionRequest::Representation
  command.request_object = google_cloud_integrations_v1alpha_lift_suspension_request_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaLiftSuspensionResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaLiftSuspensionResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

Links a existing Apps Script project.

Parameters:

  • parent (String)

    Required. The project that the executed integration belongs to.

  • google_cloud_integrations_v1alpha_link_apps_script_project_request_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



177
178
179
180
181
182
183
184
185
186
187
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 177

def link_project_location_apps_script_project(parent, google_cloud_integrations_v1alpha_link_apps_script_project_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/appsScriptProjects:link', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest::Representation
  command.request_object = google_cloud_integrations_v1alpha_link_apps_script_project_request_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_auth_configs(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListAuthConfigsResponse

Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.

Parameters:

  • parent (String)

    Required. The client, which owns this collection of AuthConfigs.

  • filter (String) (defaults to: nil)

    Filtering as supported in https://developers.google.com/authorized-buyers/apis/ guides/list-filters.

  • page_size (Fixnum) (defaults to: nil)

    The size of entries in the response. If unspecified, defaults to 100.

  • page_token (String) (defaults to: nil)

    The token returned in the previous response.

  • read_mask (String) (defaults to: nil)

    The mask which specifies fields that need to be returned in the AuthConfig's response.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



356
357
358
359
360
361
362
363
364
365
366
367
368
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 356

def list_project_location_auth_configs(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/authConfigs', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListAuthConfigsResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListAuthConfigsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_connection_runtime_action_schemas(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse

Lists the JSON schemas for the inputs and outputs of actions, filtered by action name.

Parameters:

  • parent (String)

    Required. Parent resource of RuntimeActionSchema. Format: projects/project/ locations/location/connections/connection

  • filter (String) (defaults to: nil)

    Filter. Only the action field with literal equality operator is supported.

  • page_size (Fixnum) (defaults to: nil)

    Page size.

  • page_token (String) (defaults to: nil)

    Page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



583
584
585
586
587
588
589
590
591
592
593
594
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 583

def list_project_location_connection_runtime_action_schemas(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/runtimeActionSchemas', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_connection_runtime_entity_schemas(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse

Lists the JSON schemas for the properties of runtime entities, filtered by entity name.

Parameters:

  • parent (String)

    Required. Parent resource of RuntimeEntitySchema. Format: projects/project/ locations/location/connections/connection

  • filter (String) (defaults to: nil)

    Filter. Only the entity field with literal equality operator is supported.

  • page_size (Fixnum) (defaults to: nil)

    Page size.

  • page_token (String) (defaults to: nil)

    Page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



624
625
626
627
628
629
630
631
632
633
634
635
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 624

def list_project_location_connection_runtime_entity_schemas(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/runtimeEntitySchemas', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_connections(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListConnectionsResponse

Lists Connections in a given project and location.

Parameters:

  • parent (String)

    Required. Parent resource of the Connection, of the form: projects/*/ locations/*

  • filter (String) (defaults to: nil)

    Filter.

  • order_by (String) (defaults to: nil)

    Order by parameters.

  • page_size (Fixnum) (defaults to: nil)

    Page size.

  • page_token (String) (defaults to: nil)

    Page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



541
542
543
544
545
546
547
548
549
550
551
552
553
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 541

def list_project_location_connections(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/connections', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListConnectionsResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListConnectionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_integration_execution_suspensions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListSuspensionsResponse

  • Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.

Parameters:

  • parent (String)

    Required. projects/gcp_project_id/locations/location/products/product/ integrations/integration_name/executions/execution_name

  • filter (String) (defaults to: nil)

    Standard filter field.

  • order_by (String) (defaults to: nil)

    Field name to order by.

  • page_size (Fixnum) (defaults to: nil)

    Maximum number of entries in the response.

  • page_token (String) (defaults to: nil)

    Token to retrieve a specific page.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 998

def list_project_location_integration_execution_suspensions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/suspensions', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListSuspensionsResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListSuspensionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_integration_executions(parent, filter: nil, filter_params_custom_filter: nil, filter_params_end_time: nil, filter_params_event_statuses: nil, filter_params_execution_id: nil, filter_params_parameter_key: nil, filter_params_parameter_pair_key: nil, filter_params_parameter_pair_value: nil, filter_params_parameter_type: nil, filter_params_parameter_value: nil, filter_params_start_time: nil, filter_params_task_statuses: nil, filter_params_workflow_name: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, refresh_acl: nil, truncate_params: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListExecutionsResponse

Lists the results of all the integration executions. The response includes the same information as the execution log in the Integration UI.

Parameters:

  • parent (String)

    Required. The parent resource name of the integration execution.

  • filter (String) (defaults to: nil)

    Optional. Standard filter field, we support filtering on following fields: workflow_name: the name of the integration. CreateTimestamp: the execution created time. event_execution_state: the state of the executions. execution_id: the id of the execution. trigger_id: the id of the trigger. parameter_type: the type of the parameters involved in the execution. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterType support for HAS For example: "parameter_type" HAS \"string\" Also supports operators like AND, OR, NOT For example, trigger_id=\"id1\" AND workflow_name=\"testWorkflow\"

  • filter_params_custom_filter (String) (defaults to: nil)

    Optional user-provided custom filter.

  • filter_params_end_time (Fixnum) (defaults to: nil)

    End timestamp.

  • filter_params_event_statuses (Array<String>, String) (defaults to: nil)

    List of possible event statuses.

  • filter_params_execution_id (String) (defaults to: nil)

    Execution id.

  • filter_params_parameter_key (String) (defaults to: nil)

    Param key. DEPRECATED. User parameter_pair_key instead.

  • filter_params_parameter_pair_key (String) (defaults to: nil)

    Param key in the key value pair filter.

  • filter_params_parameter_pair_value (String) (defaults to: nil)

    Param value in the key value pair filter.

  • filter_params_parameter_type (String) (defaults to: nil)

    Param type.

  • filter_params_parameter_value (String) (defaults to: nil)

    Param value. DEPRECATED. User parameter_pair_value instead.

  • filter_params_start_time (Fixnum) (defaults to: nil)

    Start timestamp.

  • filter_params_task_statuses (Array<String>, String) (defaults to: nil)

    List of possible task statuses.

  • filter_params_workflow_name (String) (defaults to: nil)

    Workflow name.

  • order_by (String) (defaults to: nil)

    Optional. The results would be returned in order you specified here. Currently supporting "last_modified_time" and "create_time".

  • page_size (Fixnum) (defaults to: nil)

    Optional. The size of entries in the response.

  • page_token (String) (defaults to: nil)

    Optional. The token returned in the previous response.

  • read_mask (String) (defaults to: nil)

    Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution info will be filled and returned.

  • refresh_acl (Boolean) (defaults to: nil)

    Optional. If true, the service will use the most recent acl information to list event execution infos and renew the acl cache. Note that fetching the most recent acl is synchronous, so it will increase RPC call latency.

  • truncate_params (Boolean) (defaults to: nil)

    Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 902

def list_project_location_integration_executions(parent, filter: nil, filter_params_custom_filter: nil, filter_params_end_time: nil, filter_params_event_statuses: nil, filter_params_execution_id: nil, filter_params_parameter_key: nil, filter_params_parameter_pair_key: nil, filter_params_parameter_pair_value: nil, filter_params_parameter_type: nil, filter_params_parameter_value: nil, filter_params_start_time: nil, filter_params_task_statuses: nil, filter_params_workflow_name: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, refresh_acl: nil, truncate_params: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/executions', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListExecutionsResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListExecutionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['filterParams.customFilter'] = filter_params_custom_filter unless filter_params_custom_filter.nil?
  command.query['filterParams.endTime'] = filter_params_end_time unless filter_params_end_time.nil?
  command.query['filterParams.eventStatuses'] = filter_params_event_statuses unless filter_params_event_statuses.nil?
  command.query['filterParams.executionId'] = filter_params_execution_id unless filter_params_execution_id.nil?
  command.query['filterParams.parameterKey'] = filter_params_parameter_key unless filter_params_parameter_key.nil?
  command.query['filterParams.parameterPairKey'] = filter_params_parameter_pair_key unless filter_params_parameter_pair_key.nil?
  command.query['filterParams.parameterPairValue'] = filter_params_parameter_pair_value unless filter_params_parameter_pair_value.nil?
  command.query['filterParams.parameterType'] = filter_params_parameter_type unless filter_params_parameter_type.nil?
  command.query['filterParams.parameterValue'] = filter_params_parameter_value unless filter_params_parameter_value.nil?
  command.query['filterParams.startTime'] = filter_params_start_time unless filter_params_start_time.nil?
  command.query['filterParams.taskStatuses'] = filter_params_task_statuses unless filter_params_task_statuses.nil?
  command.query['filterParams.workflowName'] = filter_params_workflow_name unless filter_params_workflow_name.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['refreshAcl'] = refresh_acl unless refresh_acl.nil?
  command.query['truncateParams'] = truncate_params unless truncate_params.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_integration_versions(parent, field_mask: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse

Returns the list of all integration versions in the specified project.

Parameters:

  • parent (String)

    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".

  • field_mask (String) (defaults to: nil)

    The field mask which specifies the particular data to be returned.

  • filter (String) (defaults to: nil)

    Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" ( inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state= ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like task_config.

  • order_by (String) (defaults to: nil)

    The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for "last_modified_time", "created_time", "snapshot_number" Ascending sort order for "name".

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous ListIntegrationVersions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListIntegrationVersions must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1243

def list_project_location_integration_versions(parent, field_mask: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/versions', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fieldMask'] = field_mask unless field_mask.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_integrations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListIntegrationsResponse

Returns the list of all integrations in the specified project.

Parameters:

  • parent (String)

    Required. Project and location from which the integrations should be listed. Format: projects/project

  • filter (String) (defaults to: nil)

    Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" ( inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state= ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like task_config.

  • order_by (String) (defaults to: nil)

    The results would be returned in order you specified here. Supported sort keys are: Descending sort order by "last_modified_time", "created_time", " snapshot_number". Ascending sort order by the integration name.

  • page_size (Fixnum) (defaults to: nil)

    The page size for the resquest.

  • page_token (String) (defaults to: nil)

    The page token for the resquest.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



778
779
780
781
782
783
784
785
786
787
788
789
790
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 778

def list_project_location_integrations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/integrations', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListIntegrationsResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListIntegrationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_product_auth_configs(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListAuthConfigsResponse

Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.

Parameters:

  • parent (String)

    Required. The client, which owns this collection of AuthConfigs.

  • filter (String) (defaults to: nil)

    Filtering as supported in https://developers.google.com/authorized-buyers/apis/ guides/list-filters.

  • page_size (Fixnum) (defaults to: nil)

    The size of entries in the response. If unspecified, defaults to 100.

  • page_token (String) (defaults to: nil)

    The token returned in the previous response.

  • read_mask (String) (defaults to: nil)

    The mask which specifies fields that need to be returned in the AuthConfig's response.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1619

def list_project_location_product_auth_configs(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/authConfigs', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListAuthConfigsResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListAuthConfigsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_product_certificates(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListCertificatesResponse

List all the certificates that match the filter. Restrict to certificate of current client only.

Parameters:

  • parent (String)

    Required. The client, which owns this collection of Certificates.

  • filter (String) (defaults to: nil)

    Filtering as supported in https://developers.google.com/authorized-buyers/apis/ guides/list-filters.

  • page_size (Fixnum) (defaults to: nil)

    The size of entries in the response. If unspecified, defaults to 100.

  • page_token (String) (defaults to: nil)

    The token returned in the previous response.

  • read_mask (String) (defaults to: nil)

    The mask which specifies fields that need to be returned in the Certificate's response.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1840

def list_project_location_product_certificates(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/certificates', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListCertificatesResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListCertificatesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_product_integration_execution_suspensions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListSuspensionsResponse

  • Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.

Parameters:

  • parent (String)

    Required. projects/gcp_project_id/locations/location/products/product/ integrations/integration_name/executions/execution_name

  • filter (String) (defaults to: nil)

    Standard filter field.

  • order_by (String) (defaults to: nil)

    Field name to order by.

  • page_size (Fixnum) (defaults to: nil)

    Maximum number of entries in the response.

  • page_token (String) (defaults to: nil)

    Token to retrieve a specific page.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2286

def list_project_location_product_integration_execution_suspensions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/suspensions', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListSuspensionsResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListSuspensionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_product_integration_executions(parent, filter: nil, filter_params_custom_filter: nil, filter_params_end_time: nil, filter_params_event_statuses: nil, filter_params_execution_id: nil, filter_params_parameter_key: nil, filter_params_parameter_pair_key: nil, filter_params_parameter_pair_value: nil, filter_params_parameter_type: nil, filter_params_parameter_value: nil, filter_params_start_time: nil, filter_params_task_statuses: nil, filter_params_workflow_name: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, refresh_acl: nil, truncate_params: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListExecutionsResponse

Lists the results of all the integration executions. The response includes the same information as the execution log in the Integration UI.

Parameters:

  • parent (String)

    Required. The parent resource name of the integration execution.

  • filter (String) (defaults to: nil)

    Optional. Standard filter field, we support filtering on following fields: workflow_name: the name of the integration. CreateTimestamp: the execution created time. event_execution_state: the state of the executions. execution_id: the id of the execution. trigger_id: the id of the trigger. parameter_type: the type of the parameters involved in the execution. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterType support for HAS For example: "parameter_type" HAS \"string\" Also supports operators like AND, OR, NOT For example, trigger_id=\"id1\" AND workflow_name=\"testWorkflow\"

  • filter_params_custom_filter (String) (defaults to: nil)

    Optional user-provided custom filter.

  • filter_params_end_time (Fixnum) (defaults to: nil)

    End timestamp.

  • filter_params_event_statuses (Array<String>, String) (defaults to: nil)

    List of possible event statuses.

  • filter_params_execution_id (String) (defaults to: nil)

    Execution id.

  • filter_params_parameter_key (String) (defaults to: nil)

    Param key. DEPRECATED. User parameter_pair_key instead.

  • filter_params_parameter_pair_key (String) (defaults to: nil)

    Param key in the key value pair filter.

  • filter_params_parameter_pair_value (String) (defaults to: nil)

    Param value in the key value pair filter.

  • filter_params_parameter_type (String) (defaults to: nil)

    Param type.

  • filter_params_parameter_value (String) (defaults to: nil)

    Param value. DEPRECATED. User parameter_pair_value instead.

  • filter_params_start_time (Fixnum) (defaults to: nil)

    Start timestamp.

  • filter_params_task_statuses (Array<String>, String) (defaults to: nil)

    List of possible task statuses.

  • filter_params_workflow_name (String) (defaults to: nil)

    Workflow name.

  • order_by (String) (defaults to: nil)

    Optional. The results would be returned in order you specified here. Currently supporting "last_modified_time" and "create_time".

  • page_size (Fixnum) (defaults to: nil)

    Optional. The size of entries in the response.

  • page_token (String) (defaults to: nil)

    Optional. The token returned in the previous response.

  • read_mask (String) (defaults to: nil)

    Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution info will be filled and returned.

  • refresh_acl (Boolean) (defaults to: nil)

    Optional. If true, the service will use the most recent acl information to list event execution infos and renew the acl cache. Note that fetching the most recent acl is synchronous, so it will increase RPC call latency.

  • truncate_params (Boolean) (defaults to: nil)

    Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2190

def list_project_location_product_integration_executions(parent, filter: nil, filter_params_custom_filter: nil, filter_params_end_time: nil, filter_params_event_statuses: nil, filter_params_execution_id: nil, filter_params_parameter_key: nil, filter_params_parameter_pair_key: nil, filter_params_parameter_pair_value: nil, filter_params_parameter_type: nil, filter_params_parameter_value: nil, filter_params_start_time: nil, filter_params_task_statuses: nil, filter_params_workflow_name: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, refresh_acl: nil, truncate_params: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/executions', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListExecutionsResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListExecutionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['filterParams.customFilter'] = filter_params_custom_filter unless filter_params_custom_filter.nil?
  command.query['filterParams.endTime'] = filter_params_end_time unless filter_params_end_time.nil?
  command.query['filterParams.eventStatuses'] = filter_params_event_statuses unless filter_params_event_statuses.nil?
  command.query['filterParams.executionId'] = filter_params_execution_id unless filter_params_execution_id.nil?
  command.query['filterParams.parameterKey'] = filter_params_parameter_key unless filter_params_parameter_key.nil?
  command.query['filterParams.parameterPairKey'] = filter_params_parameter_pair_key unless filter_params_parameter_pair_key.nil?
  command.query['filterParams.parameterPairValue'] = filter_params_parameter_pair_value unless filter_params_parameter_pair_value.nil?
  command.query['filterParams.parameterType'] = filter_params_parameter_type unless filter_params_parameter_type.nil?
  command.query['filterParams.parameterValue'] = filter_params_parameter_value unless filter_params_parameter_value.nil?
  command.query['filterParams.startTime'] = filter_params_start_time unless filter_params_start_time.nil?
  command.query['filterParams.taskStatuses'] = filter_params_task_statuses unless filter_params_task_statuses.nil?
  command.query['filterParams.workflowName'] = filter_params_workflow_name unless filter_params_workflow_name.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['refreshAcl'] = refresh_acl unless refresh_acl.nil?
  command.query['truncateParams'] = truncate_params unless truncate_params.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_product_integration_versions(parent, field_mask: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse

Returns the list of all integration versions in the specified project.

Parameters:

  • parent (String)

    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".

  • field_mask (String) (defaults to: nil)

    The field mask which specifies the particular data to be returned.

  • filter (String) (defaults to: nil)

    Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" ( inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state= ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like task_config.

  • order_by (String) (defaults to: nil)

    The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for "last_modified_time", "created_time", "snapshot_number" Ascending sort order for "name".

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous ListIntegrationVersions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListIntegrationVersions must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2531

def list_project_location_product_integration_versions(parent, field_mask: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/versions', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fieldMask'] = field_mask unless field_mask.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_product_integrations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListIntegrationsResponse

Returns the list of all integrations in the specified project.

Parameters:

  • parent (String)

    Required. Project and location from which the integrations should be listed. Format: projects/project

  • filter (String) (defaults to: nil)

    Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" ( inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state= ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like task_config.

  • order_by (String) (defaults to: nil)

    The results would be returned in order you specified here. Supported sort keys are: Descending sort order by "last_modified_time", "created_time", " snapshot_number". Ascending sort order by the integration name.

  • page_size (Fixnum) (defaults to: nil)

    The page size for the resquest.

  • page_token (String) (defaults to: nil)

    The page token for the resquest.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1999

def list_project_location_product_integrations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/integrations', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListIntegrationsResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListIntegrationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_product_integrationtemplate_versions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListIntegrationTemplateVersionsResponse

Returns the list of all IntegrationTemplateVersions in the specified project.

Parameters:

  • parent (String)

    Required. Format: projects/project/location/location/product/product/ integrationtemplates/integrationtemplate

  • filter (String) (defaults to: nil)

    Filter syntax: defined in the EBNF grammar.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of IntegrationTemplateVersions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous ListIntegrationTemplateVersions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListIntegrationTemplateVersions must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2839

def list_project_location_product_integrationtemplate_versions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/versions', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListIntegrationTemplateVersionsResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListIntegrationTemplateVersionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_product_sfdc_instance_sfdc_channels(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse

Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.

Parameters:

  • parent (String)

    Required. The client, which owns this collection of SfdcChannels.

  • filter (String) (defaults to: nil)

    Filtering as supported in https://developers.google.com/authorized-buyers/apis/ guides/list-filters.

  • page_size (Fixnum) (defaults to: nil)

    The size of entries in the response. If unspecified, defaults to 100.

  • page_token (String) (defaults to: nil)

    The token returned in the previous response.

  • read_mask (String) (defaults to: nil)

    The mask which specifies fields that need to be returned in the SfdcChannel's response.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 3157

def list_project_location_product_sfdc_instance_sfdc_channels(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/sfdcChannels', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_product_sfdc_instances(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse

Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.

Parameters:

  • parent (String)

    Required. The client, which owns this collection of SfdcInstances.

  • filter (String) (defaults to: nil)

    Filtering as supported in https://developers.google.com/authorized-buyers/apis/ guides/list-filters.

  • page_size (Fixnum) (defaults to: nil)

    The size of entries in the response. If unspecified, defaults to 100.

  • page_token (String) (defaults to: nil)

    The token returned in the previous response.

  • read_mask (String) (defaults to: nil)

    The mask which specifies fields that need to be returned in the SfdcInstance's response.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2978

def list_project_location_product_sfdc_instances(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/sfdcInstances', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_sfdc_instance_sfdc_channels(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse

Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.

Parameters:

  • parent (String)

    Required. The client, which owns this collection of SfdcChannels.

  • filter (String) (defaults to: nil)

    Filtering as supported in https://developers.google.com/authorized-buyers/apis/ guides/list-filters.

  • page_size (Fixnum) (defaults to: nil)

    The size of entries in the response. If unspecified, defaults to 100.

  • page_token (String) (defaults to: nil)

    The token returned in the previous response.

  • read_mask (String) (defaults to: nil)

    The mask which specifies fields that need to be returned in the SfdcChannel's response.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 3515

def list_project_location_sfdc_instance_sfdc_channels(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/sfdcChannels', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_sfdc_instances(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse

Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.

Parameters:

  • parent (String)

    Required. The client, which owns this collection of SfdcInstances.

  • filter (String) (defaults to: nil)

    Filtering as supported in https://developers.google.com/authorized-buyers/apis/ guides/list-filters.

  • page_size (Fixnum) (defaults to: nil)

    The size of entries in the response. If unspecified, defaults to 100.

  • page_token (String) (defaults to: nil)

    The token returned in the previous response.

  • read_mask (String) (defaults to: nil)

    The mask which specifies fields that need to be returned in the SfdcInstance's response.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 3336

def list_project_location_sfdc_instances(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/sfdcInstances', options)
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_auth_config(name, google_cloud_integrations_v1alpha_auth_config_object = nil, client_certificate_encrypted_private_key: nil, client_certificate_passphrase: nil, client_certificate_ssl_certificate: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig

Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.

Parameters:

  • name (String)

    Resource name of the SFDC instance projects/project/locations/location/ authConfigs/authConfig.

  • google_cloud_integrations_v1alpha_auth_config_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig) (defaults to: nil)
  • client_certificate_encrypted_private_key (String) (defaults to: nil)

    The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/ sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/ BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----

  • client_certificate_passphrase (String) (defaults to: nil)

    'passphrase' should be left unset if private key is not encrypted. Note that ' passphrase' is not the password for web server, but an extra layer of security to protected private key.

  • client_certificate_ssl_certificate (String) (defaults to: nil)

    The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/ sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/ BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----

  • update_mask (String) (defaults to: nil)

    Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 434

def patch_project_location_auth_config(name, google_cloud_integrations_v1alpha_auth_config_object = nil, client_certificate_encrypted_private_key: nil, client_certificate_passphrase: nil, client_certificate_ssl_certificate: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha/{+name}', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig::Representation
  command.request_object = google_cloud_integrations_v1alpha_auth_config_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig
  command.params['name'] = name unless name.nil?
  command.query['clientCertificate.encryptedPrivateKey'] = client_certificate_encrypted_private_key unless client_certificate_encrypted_private_key.nil?
  command.query['clientCertificate.passphrase'] = client_certificate_passphrase unless client_certificate_passphrase.nil?
  command.query['clientCertificate.sslCertificate'] = client_certificate_ssl_certificate unless client_certificate_ssl_certificate.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_integration_version(name, google_cloud_integrations_v1alpha_integration_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion

Update a integration with a draft version in the specified project.

Parameters:

  • name (String)

    Output only. Auto-generated primary key.

  • google_cloud_integrations_v1alpha_integration_version_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Field mask specifying the fields in the above integration that have been modified and need to be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1282

def patch_project_location_integration_version(name, google_cloud_integrations_v1alpha_integration_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha/{+name}', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion::Representation
  command.request_object = google_cloud_integrations_v1alpha_integration_version_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_product_auth_config(name, google_cloud_integrations_v1alpha_auth_config_object = nil, client_certificate_encrypted_private_key: nil, client_certificate_passphrase: nil, client_certificate_ssl_certificate: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig

Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.

Parameters:

  • name (String)

    Resource name of the SFDC instance projects/project/locations/location/ authConfigs/authConfig.

  • google_cloud_integrations_v1alpha_auth_config_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig) (defaults to: nil)
  • client_certificate_encrypted_private_key (String) (defaults to: nil)

    The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/ sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/ BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----

  • client_certificate_passphrase (String) (defaults to: nil)

    'passphrase' should be left unset if private key is not encrypted. Note that ' passphrase' is not the password for web server, but an extra layer of security to protected private key.

  • client_certificate_ssl_certificate (String) (defaults to: nil)

    The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/ sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/ BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----

  • update_mask (String) (defaults to: nil)

    Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1697

def patch_project_location_product_auth_config(name, google_cloud_integrations_v1alpha_auth_config_object = nil, client_certificate_encrypted_private_key: nil, client_certificate_passphrase: nil, client_certificate_ssl_certificate: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha/{+name}', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig::Representation
  command.request_object = google_cloud_integrations_v1alpha_auth_config_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaAuthConfig
  command.params['name'] = name unless name.nil?
  command.query['clientCertificate.encryptedPrivateKey'] = client_certificate_encrypted_private_key unless client_certificate_encrypted_private_key.nil?
  command.query['clientCertificate.passphrase'] = client_certificate_passphrase unless client_certificate_passphrase.nil?
  command.query['clientCertificate.sslCertificate'] = client_certificate_ssl_certificate unless client_certificate_ssl_certificate.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_product_certificate(name, google_cloud_integrations_v1alpha_certificate_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCertificate

Updates the certificate by id. If new certificate file is updated, it will register with the trawler service, re-encrypt with cloud KMS and update the Spanner record. Other fields will directly update the Spanner record. Returns the Certificate.

Parameters:

  • name (String)

    Output only. Auto generated primary key

  • google_cloud_integrations_v1alpha_certificate_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCertificate) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Field mask specifying the fields in the above Certificate that have been modified and need to be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1881

def patch_project_location_product_certificate(name, google_cloud_integrations_v1alpha_certificate_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha/{+name}', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCertificate::Representation
  command.request_object = google_cloud_integrations_v1alpha_certificate_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCertificate::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCertificate
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_product_integration_version(name, google_cloud_integrations_v1alpha_integration_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion

Update a integration with a draft version in the specified project.

Parameters:

  • name (String)

    Output only. Auto-generated primary key.

  • google_cloud_integrations_v1alpha_integration_version_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Field mask specifying the fields in the above integration that have been modified and need to be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2570

def patch_project_location_product_integration_version(name, google_cloud_integrations_v1alpha_integration_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha/{+name}', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion::Representation
  command.request_object = google_cloud_integrations_v1alpha_integration_version_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaIntegrationVersion
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_product_sfdc_instance(name, google_cloud_integrations_v1alpha_sfdc_instance_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance

Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.

Parameters:

  • name (String)

    Resource name of the SFDC instance projects/project/locations/location/ sfdcInstances/sfdcInstance.

  • google_cloud_integrations_v1alpha_sfdc_instance_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 3018

def patch_project_location_product_sfdc_instance(name, google_cloud_integrations_v1alpha_sfdc_instance_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha/{+name}', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance::Representation
  command.request_object = google_cloud_integrations_v1alpha_sfdc_instance_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_product_sfdc_instance_sfdc_channel(name, google_cloud_integrations_v1alpha_sfdc_channel_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel

Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.

Parameters:

  • name (String)

    Resource name of the SFDC channel projects/project/locations/location/ sfdcInstances/sfdc_instance/sfdcChannels/sfdc_channel.

  • google_cloud_integrations_v1alpha_sfdc_channel_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 3197

def patch_project_location_product_sfdc_instance_sfdc_channel(name, google_cloud_integrations_v1alpha_sfdc_channel_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha/{+name}', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel::Representation
  command.request_object = google_cloud_integrations_v1alpha_sfdc_channel_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_sfdc_instance(name, google_cloud_integrations_v1alpha_sfdc_instance_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance

Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.

Parameters:

  • name (String)

    Resource name of the SFDC instance projects/project/locations/location/ sfdcInstances/sfdcInstance.

  • google_cloud_integrations_v1alpha_sfdc_instance_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 3376

def patch_project_location_sfdc_instance(name, google_cloud_integrations_v1alpha_sfdc_instance_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha/{+name}', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance::Representation
  command.request_object = google_cloud_integrations_v1alpha_sfdc_instance_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcInstance
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_sfdc_instance_sfdc_channel(name, google_cloud_integrations_v1alpha_sfdc_channel_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel

Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.

Parameters:

  • name (String)

    Resource name of the SFDC channel projects/project/locations/location/ sfdcInstances/sfdc_instance/sfdcChannels/sfdc_channel.

  • google_cloud_integrations_v1alpha_sfdc_channel_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 3555

def patch_project_location_sfdc_instance_sfdc_channel(name, google_cloud_integrations_v1alpha_sfdc_channel_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha/{+name}', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel::Representation
  command.request_object = google_cloud_integrations_v1alpha_sfdc_channel_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSfdcChannel
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#publish_project_location_integration_version(name, google_cloud_integrations_v1alpha_publish_integration_version_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse

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.

Parameters:

  • name (String)

    Required. The version to publish. Format: projects/project/locations/ location/integrations/integration/versions/version

  • google_cloud_integrations_v1alpha_publish_integration_version_request_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1322

def publish_project_location_integration_version(name, google_cloud_integrations_v1alpha_publish_integration_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:publish', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest::Representation
  command.request_object = google_cloud_integrations_v1alpha_publish_integration_version_request_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#publish_project_location_product_integration_version(name, google_cloud_integrations_v1alpha_publish_integration_version_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse

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.

Parameters:

  • name (String)

    Required. The version to publish. Format: projects/project/locations/ location/integrations/integration/versions/version

  • google_cloud_integrations_v1alpha_publish_integration_version_request_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2610

def publish_project_location_product_integration_version(name, google_cloud_integrations_v1alpha_publish_integration_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:publish', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest::Representation
  command.request_object = google_cloud_integrations_v1alpha_publish_integration_version_request_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#resolve_project_location_integration_execution_suspension(name, google_cloud_integrations_v1alpha_resolve_suspension_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaResolveSuspensionResponse

  • Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again.

Parameters:

  • name (String)

    Required. projects/gcp_project_id/locations/location/products/product/ integrations/integration_name/executions/execution_name/suspensions/ suspension_id

  • google_cloud_integrations_v1alpha_resolve_suspension_request_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaResolveSuspensionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1037

def resolve_project_location_integration_execution_suspension(name, google_cloud_integrations_v1alpha_resolve_suspension_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:resolve', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaResolveSuspensionRequest::Representation
  command.request_object = google_cloud_integrations_v1alpha_resolve_suspension_request_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaResolveSuspensionResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaResolveSuspensionResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#resolve_project_location_product_integration_execution_suspension(name, google_cloud_integrations_v1alpha_resolve_suspension_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaResolveSuspensionResponse

  • Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again.

Parameters:

  • name (String)

    Required. projects/gcp_project_id/locations/location/products/product/ integrations/integration_name/executions/execution_name/suspensions/ suspension_id

  • google_cloud_integrations_v1alpha_resolve_suspension_request_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaResolveSuspensionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2325

def resolve_project_location_product_integration_execution_suspension(name, google_cloud_integrations_v1alpha_resolve_suspension_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:resolve', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaResolveSuspensionRequest::Representation
  command.request_object = google_cloud_integrations_v1alpha_resolve_suspension_request_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaResolveSuspensionResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaResolveSuspensionResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#schedule_project_location_integration(name, google_cloud_integrations_v1alpha_schedule_integrations_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse

Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.

Parameters:

  • name (String)

    The integration resource name.

  • google_cloud_integrations_v1alpha_schedule_integrations_request_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



814
815
816
817
818
819
820
821
822
823
824
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 814

def schedule_project_location_integration(name, google_cloud_integrations_v1alpha_schedule_integrations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:schedule', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest::Representation
  command.request_object = google_cloud_integrations_v1alpha_schedule_integrations_request_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#schedule_project_location_product_integration(name, google_cloud_integrations_v1alpha_schedule_integrations_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse

Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.

Parameters:

  • name (String)

    The integration resource name.

  • google_cloud_integrations_v1alpha_schedule_integrations_request_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2035

def schedule_project_location_product_integration(name, google_cloud_integrations_v1alpha_schedule_integrations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:schedule', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest::Representation
  command.request_object = google_cloud_integrations_v1alpha_schedule_integrations_request_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#takeover_project_location_integration_version_edit_lock(integration_version, google_cloud_integrations_v1alpha_takeover_edit_lock_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse

Clears the locked_by and locked_at_timestampin 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.

Parameters:

  • integration_version (String)

    Required. The version to take over edit lock. Format: projects/project/ locations/location/integrations/integration/versions/version

  • google_cloud_integrations_v1alpha_takeover_edit_lock_request_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1366

def takeover_project_location_integration_version_edit_lock(integration_version, google_cloud_integrations_v1alpha_takeover_edit_lock_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+integrationVersion}:takeoverEditLock', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest::Representation
  command.request_object = google_cloud_integrations_v1alpha_takeover_edit_lock_request_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse
  command.params['integrationVersion'] = integration_version unless integration_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#takeover_project_location_product_integration_version_edit_lock(integration_version, google_cloud_integrations_v1alpha_takeover_edit_lock_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse

Clears the locked_by and locked_at_timestampin 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.

Parameters:

  • integration_version (String)

    Required. The version to take over edit lock. Format: projects/project/ locations/location/integrations/integration/versions/version

  • google_cloud_integrations_v1alpha_takeover_edit_lock_request_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2654

def takeover_project_location_product_integration_version_edit_lock(integration_version, google_cloud_integrations_v1alpha_takeover_edit_lock_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+integrationVersion}:takeoverEditLock', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest::Representation
  command.request_object = google_cloud_integrations_v1alpha_takeover_edit_lock_request_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse
  command.params['integrationVersion'] = integration_version unless integration_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#unpublish_project_location_integration_version(name, google_cloud_integrations_v1alpha_unpublish_integration_version_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty

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.

Parameters:

  • name (String)

    Required. The version to deactivate. Format: projects/project/locations/ location/integrations/integration/versions/version

  • google_cloud_integrations_v1alpha_unpublish_integration_version_request_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1403

def unpublish_project_location_integration_version(name, google_cloud_integrations_v1alpha_unpublish_integration_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:unpublish', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest::Representation
  command.request_object = google_cloud_integrations_v1alpha_unpublish_integration_version_request_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#unpublish_project_location_product_integration_version(name, google_cloud_integrations_v1alpha_unpublish_integration_version_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty

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.

Parameters:

  • name (String)

    Required. The version to deactivate. Format: projects/project/locations/ location/integrations/integration/versions/version

  • google_cloud_integrations_v1alpha_unpublish_integration_version_request_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2691

def unpublish_project_location_product_integration_version(name, google_cloud_integrations_v1alpha_unpublish_integration_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:unpublish', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest::Representation
  command.request_object = google_cloud_integrations_v1alpha_unpublish_integration_version_request_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upload_project_location_integration_version(parent, google_cloud_integrations_v1alpha_upload_integration_version_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse

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.

Parameters:

  • parent (String)

    Required. The version to upload. Format: projects/project/locations/ location/integrations/integration

  • google_cloud_integrations_v1alpha_upload_integration_version_request_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 1440

def upload_project_location_integration_version(parent, google_cloud_integrations_v1alpha_upload_integration_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/versions:upload', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest::Representation
  command.request_object = google_cloud_integrations_v1alpha_upload_integration_version_request_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upload_project_location_product_integration_version(parent, google_cloud_integrations_v1alpha_upload_integration_version_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse

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.

Parameters:

  • parent (String)

    Required. The version to upload. Format: projects/project/locations/ location/integrations/integration

  • google_cloud_integrations_v1alpha_upload_integration_version_request_object (Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
# File 'lib/google/apis/integrations_v1alpha/service.rb', line 2728

def upload_project_location_product_integration_version(parent, google_cloud_integrations_v1alpha_upload_integration_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/versions:upload', options)
  command.request_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest::Representation
  command.request_object = google_cloud_integrations_v1alpha_upload_integration_version_request_object
  command.response_representation = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse::Representation
  command.response_class = Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end