close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

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

Args:
parent: string, Required. "projects/{project}/locations/{location}" format. (required)
body: object, The request body.
The object takes the form of:

{ # The SfdcChannel that points to a CDC or Platform Event Channel.
"channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
"createTime": "A String", # Output only. Time when the channel is created
"deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
"description": "A String", # The description for this channel
"displayName": "A String", # Client level unique name/alias to easily reference a channel.
"isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
"lastReplayId": "A String", # Last sfdc messsage replay id for channel
"name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
"updateTime": "A String", # Output only. Time when the channel was last updated
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # The SfdcChannel that points to a CDC or Platform Event Channel.
"channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
"createTime": "A String", # Output only. Time when the channel is created
"deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
"description": "A String", # The description for this channel
"displayName": "A String", # Client level unique name/alias to easily reference a channel.
"isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
"lastReplayId": "A String", # Last sfdc messsage replay id for channel
"name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
"updateTime": "A String", # Output only. Time when the channel was last updated
}

delete(name, x__xgafv=None)

Deletes an sfdc channel.

Args:
  name: string, Required. The name that is associated with the SfdcChannel. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

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

Args:
  name: string, Required. The name that is associated with the SfdcChannel. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The SfdcChannel that points to a CDC or Platform Event Channel.
  "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
  "createTime": "A String", # Output only. Time when the channel is created
  "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
  "description": "A String", # The description for this channel
  "displayName": "A String", # Client level unique name/alias to easily reference a channel.
  "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
  "lastReplayId": "A String", # Last sfdc messsage replay id for channel
  "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
  "updateTime": "A String", # Output only. Time when the channel was last updated
}

list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)

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

Args:
parent: string, Required. The client, which owns this collection of SfdcChannels. (required)
filter: string, Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
pageSize: integer, The size of entries in the response. If unspecified, defaults to 100.
pageToken: string, The token returned in the previous response.
readMask: string, The mask which specifies fields that need to be returned in the SfdcChannel's response.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response to list SfdcChannels.
"nextPageToken": "A String", # The token used to retrieve the next page of results.
"sfdcChannels": [ # The list of SfdcChannels retrieved.
{ # The SfdcChannel that points to a CDC or Platform Event Channel.
"channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
"createTime": "A String", # Output only. Time when the channel is created
"deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
"description": "A String", # The description for this channel
"displayName": "A String", # Client level unique name/alias to easily reference a channel.
"isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
"lastReplayId": "A String", # Last sfdc messsage replay id for channel
"name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
"updateTime": "A String", # Output only. Time when the channel was last updated
},
],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, body=None, updateMask=None, x__xgafv=None)

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

Args:
name: string, Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}. (required)
body: object, The request body.
The object takes the form of:

{ # The SfdcChannel that points to a CDC or Platform Event Channel.
"channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
"createTime": "A String", # Output only. Time when the channel is created
"deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
"description": "A String", # The description for this channel
"displayName": "A String", # Client level unique name/alias to easily reference a channel.
"isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
"lastReplayId": "A String", # Last sfdc messsage replay id for channel
"name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
"updateTime": "A String", # Output only. Time when the channel was last updated
}

updateMask: string, Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # The SfdcChannel that points to a CDC or Platform Event Channel.
"channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
"createTime": "A String", # Output only. Time when the channel is created
"deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
"description": "A String", # The description for this channel
"displayName": "A String", # Client level unique name/alias to easily reference a channel.
"isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
"lastReplayId": "A String", # Last sfdc messsage replay id for channel
"name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
"updateTime": "A String", # Output only. Time when the channel was last updated
}

Application Integration API . projects . locations . sfdcInstances . sfdcChannels

Instance Methods

Method Details