Apigee API . organizations . sharedflows

close()

Close httplib2 connections.

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

Uploads a ZIP-formatted shared flow configuration bundle to an organization. If the shared flow already exists, this creates a new revision of it. If the shared flow does not exist, this creates it. Once imported, the shared flow revision must be deployed before it can be accessed at runtime. The size limit of a shared flow bundle is 15 MB.

Args:
  parent: string, Required. The name of the parent organization under which to create the shared flow. Must be of the form: `organizations/{organization_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
  "data": "A String", # The HTTP request/response body as raw binary.
  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
    {
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  ],
}

  action: string, Required. Must be set to either `import` or `validate`.
  name: string, Required. The name to give the shared flow
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The metadata describing a shared flow revision.
  "configurationVersion": { # Version of the API proxy configuration schema. Currently, only 4.0 is supported. # The version of the configuration schema to which this shared flow conforms. The only supported value currently is majorVersion 4 and minorVersion 0. This setting may be used in the future to enable evolution of the shared flow format.
    "majorVersion": 42, # Major version of the API proxy configuration schema.
    "minorVersion": 42, # Minor version of the API proxy configuration schema.
  },
  "contextInfo": "A String", # A textual description of the shared flow revision.
  "createdAt": "A String", # Time at which this shared flow revision was created, in milliseconds since epoch.
  "description": "A String", # Description of the shared flow revision.
  "displayName": "A String", # The human readable name of this shared flow.
  "entityMetaDataAsProperties": { # A Key-Value map of metadata about this shared flow revision.
    "a_key": "A String",
  },
  "lastModifiedAt": "A String", # Time at which this shared flow revision was most recently modified, in milliseconds since epoch.
  "name": "A String", # The resource ID of the parent shared flow.
  "policies": [ # A list of policy names included in this shared flow revision.
    "A String",
  ],
  "resourceFiles": { # List of resource files. # The resource files included in this shared flow revision.
    "resourceFile": [ # List of resource files.
      { # Metadata about a resource file.
        "name": "A String", # ID of the resource file.
        "type": "A String", # Resource file type. {{ resource_file_type }}
      },
    ],
  },
  "resources": [ # A list of the resources included in this shared flow revision formatted as "{type}://{name}".
    "A String",
  ],
  "revision": "A String", # The resource ID of this revision.
  "sharedFlows": [ # A list of the shared flow names included in this shared flow revision.
    "A String",
  ],
  "type": "A String", # The string "Application"
}

delete(name, x__xgafv=None)

Deletes a shared flow and all it's revisions. The shared flow must be undeployed before you can delete it.

Args:
  name: string, Required. shared flow name of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The metadata describing a shared flow
  "latestRevisionId": "A String", # The id of the most recently created revision for this shared flow.
  "metaData": { # Metadata common to many entities in this API. # Metadata describing the shared flow.
    "createdAt": "A String", # Time at which the API proxy was created, in milliseconds since epoch.
    "lastModifiedAt": "A String", # Time at which the API proxy was most recently modified, in milliseconds since epoch.
    "subType": "A String", # The type of entity described
  },
  "name": "A String", # The ID of the shared flow.
  "revision": [ # A list of revisions of this shared flow.
    "A String",
  ],
}

get(name, x__xgafv=None)

Gets a shared flow by name, including a list of its revisions.

Args:
  name: string, Required. The name of the shared flow to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The metadata describing a shared flow
  "latestRevisionId": "A String", # The id of the most recently created revision for this shared flow.
  "metaData": { # Metadata common to many entities in this API. # Metadata describing the shared flow.
    "createdAt": "A String", # Time at which the API proxy was created, in milliseconds since epoch.
    "lastModifiedAt": "A String", # Time at which the API proxy was most recently modified, in milliseconds since epoch.
    "subType": "A String", # The type of entity described
  },
  "name": "A String", # The ID of the shared flow.
  "revision": [ # A list of revisions of this shared flow.
    "A String",
  ],
}

list(parent, includeMetaData=None, includeRevisions=None, x__xgafv=None)

Lists all shared flows in the organization.

Args:
  parent: string, Required. The name of the parent organization under which to get shared flows. Must be of the form: `organizations/{organization_id}` (required)
  includeMetaData: boolean, Indicates whether to include shared flow metadata in the response.
  includeRevisions: boolean, Indicates whether to include a list of revisions in the response.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "sharedFlows": [
    { # The metadata describing a shared flow
      "latestRevisionId": "A String", # The id of the most recently created revision for this shared flow.
      "metaData": { # Metadata common to many entities in this API. # Metadata describing the shared flow.
        "createdAt": "A String", # Time at which the API proxy was created, in milliseconds since epoch.
        "lastModifiedAt": "A String", # Time at which the API proxy was most recently modified, in milliseconds since epoch.
        "subType": "A String", # The type of entity described
      },
      "name": "A String", # The ID of the shared flow.
      "revision": [ # A list of revisions of this shared flow.
        "A String",
      ],
    },
  ],
}