Apigee API . organizations . datacollectors

close()

Close httplib2 connections.

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

Creates a new data collector.

Args:
  parent: string, Required. Name of the organization in which to create the data collector in the following format: `organizations/{org}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Data collector configuration.
  "createdAt": "A String", # Output only. The time at which the data collector was created in milliseconds since the epoch.
  "description": "A String", # A description of the data collector.
  "lastModifiedAt": "A String", # Output only. The time at which the Data Collector was last updated in milliseconds since the epoch.
  "name": "A String", # ID of the data collector. Must begin with `dc_`.
  "type": "A String", # Immutable. The type of data this data collector will collect.
}

  dataCollectorId: string, ID of the data collector. Overrides any ID in the data collector resource. Must be a string beginning with `dc_` that contains only letters, numbers, and underscores.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Data collector configuration.
  "createdAt": "A String", # Output only. The time at which the data collector was created in milliseconds since the epoch.
  "description": "A String", # A description of the data collector.
  "lastModifiedAt": "A String", # Output only. The time at which the Data Collector was last updated in milliseconds since the epoch.
  "name": "A String", # ID of the data collector. Must begin with `dc_`.
  "type": "A String", # Immutable. The type of data this data collector will collect.
}

delete(name, x__xgafv=None)

Deletes a data collector.

Args:
  name: string, Required. Name of the data collector in the following format: `organizations/{org}/datacollectors/{data_collector_id}`. (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 a data collector.

Args:
  name: string, Required. Name of the data collector in the following format: `organizations/{org}/datacollectors/{data_collector_id}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Data collector configuration.
  "createdAt": "A String", # Output only. The time at which the data collector was created in milliseconds since the epoch.
  "description": "A String", # A description of the data collector.
  "lastModifiedAt": "A String", # Output only. The time at which the Data Collector was last updated in milliseconds since the epoch.
  "name": "A String", # ID of the data collector. Must begin with `dc_`.
  "type": "A String", # Immutable. The type of data this data collector will collect.
}

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

Lists all data collectors.

Args:
  parent: string, Required. Name of the organization for which to list data collectors in the following format: `organizations/{org}`. (required)
  pageSize: integer, Maximum number of data collectors to return. The page size defaults to 25.
  pageToken: string, Page token, returned from a previous ListDataCollectors call, that you can use to retrieve the next page.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListDataCollectors.
  "dataCollectors": [ # Data collectors in the specified organization.
    { # Data collector configuration.
      "createdAt": "A String", # Output only. The time at which the data collector was created in milliseconds since the epoch.
      "description": "A String", # A description of the data collector.
      "lastModifiedAt": "A String", # Output only. The time at which the Data Collector was last updated in milliseconds since the epoch.
      "name": "A String", # ID of the data collector. Must begin with `dc_`.
      "type": "A String", # Immutable. The type of data this data collector will collect.
    },
  ],
  "nextPageToken": "A String", # Page token that you can include in a ListDataCollectors request to retrieve the next page. If omitted, no subsequent pages exist.
}

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 a data collector.

Args:
  name: string, Required. Name of the data collector in the following format: `organizations/{org}/datacollectors/{data_collector_id}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Data collector configuration.
  "createdAt": "A String", # Output only. The time at which the data collector was created in milliseconds since the epoch.
  "description": "A String", # A description of the data collector.
  "lastModifiedAt": "A String", # Output only. The time at which the Data Collector was last updated in milliseconds since the epoch.
  "name": "A String", # ID of the data collector. Must begin with `dc_`.
  "type": "A String", # Immutable. The type of data this data collector will collect.
}

  updateMask: string, List of fields 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:

    { # Data collector configuration.
  "createdAt": "A String", # Output only. The time at which the data collector was created in milliseconds since the epoch.
  "description": "A String", # A description of the data collector.
  "lastModifiedAt": "A String", # Output only. The time at which the Data Collector was last updated in milliseconds since the epoch.
  "name": "A String", # ID of the data collector. Must begin with `dc_`.
  "type": "A String", # Immutable. The type of data this data collector will collect.
}