Apigee API . organizations . environments . resourcefiles

Instance Methods

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

Creates a resource file.

delete(parent, type, name, x__xgafv=None)

Deletes a resource file.

get(parent, type, name, x__xgafv=None)

Gets the contents of a resource file.

list(parent, type=None, x__xgafv=None)

Lists all resource files.

listEnvironmentResources(parent, type, x__xgafv=None)

Lists all resource files.

update(parent, type, name, body=None, x__xgafv=None)

Updates a resource file.

Method Details

create(parent, body=None, type=None, name=None, x__xgafv=None)
Creates a resource file.

Specify the `Content-Type` as `application/octet-stream` or
`multipart/form-data`.

For more information about resource files, see
[Resource files](/api-platform/develop/resource-files).

Args:
  parent: string, Required. Name of the environment in which to create the resource file in the
following format:
  `organizations/{org}/environments/{env}`. (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.
    "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.
      },
    ],
    "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.
  }

  type: string, Required. Resource file type. {{ resource_file_type }}
  name: string, Required. Name of the resource file.  Must match the regular expression:
<var>[a-zA-Z0-9:/\\!@#$%^&{}\[\]()+\-=,.~'` ]{1,255}</var>
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Metadata about a resource file.
    "type": "A String", # Resource file type. {{ resource_file_type }}
    "name": "A String", # ID of the resource file.
  }
delete(parent, type, name, x__xgafv=None)
Deletes a resource file.

For more information about resource files, see
[Resource files](/api-platform/develop/resource-files).

Args:
  parent: string, Required. Name of the environment in the following format:
  `organizations/{org}/environments/{env}`. (required)
  type: string, Required. Resource file type. {{ resource_file_type }} (required)
  name: string, Required. ID of the resource file to delete. Must match the regular
expression: <var>[a-zA-Z0-9:/\\!@#$%^&{}\[\]()+\-=,.~'` ]{1,255}</var> (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Metadata about a resource file.
    "type": "A String", # Resource file type. {{ resource_file_type }}
    "name": "A String", # ID of the resource file.
  }
get(parent, type, name, x__xgafv=None)
Gets the contents of a resource file.

For more information about resource files, see
[Resource files](/api-platform/develop/resource-files).

Args:
  parent: string, Required. Name of the environment in the following format:
  `organizations/{org}/environments/{env}`. (required)
  type: string, Required. Resource file type.  {{ resource_file_type }} (required)
  name: string, Required. ID of the resource file. Must match the regular
expression: <var>[a-zA-Z0-9:/\\!@#$%^&{}\[\]()+\-=,.~'` ]{1,255}</var> (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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.
      "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.
        },
      ],
      "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.
    }
list(parent, type=None, x__xgafv=None)
Lists all resource files.

For more information about resource files, see
[Resource files](/api-platform/develop/resource-files).

Args:
  parent: string, Required. Name of the environment in which to list resource files in the following
format:
  `organizations/{org}/environments/{env}`. (required)
  type: string, Optional. Type of resource files to list.
{{ resource_file_type }}
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for
      # ListEnvironmentResources
    "resourceFile": [ # List of resources files.
      { # Metadata about a resource file.
        "type": "A String", # Resource file type. {{ resource_file_type }}
        "name": "A String", # ID of the resource file.
      },
    ],
  }
listEnvironmentResources(parent, type, x__xgafv=None)
Lists all resource files.

For more information about resource files, see
[Resource files](/api-platform/develop/resource-files).

Args:
  parent: string, Required. Name of the environment in which to list resource files in the following
format:
  `organizations/{org}/environments/{env}`. (required)
  type: string, Optional. Type of resource files to list.
{{ resource_file_type }} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for
      # ListEnvironmentResources
    "resourceFile": [ # List of resources files.
      { # Metadata about a resource file.
        "type": "A String", # Resource file type. {{ resource_file_type }}
        "name": "A String", # ID of the resource file.
      },
    ],
  }
update(parent, type, name, body=None, x__xgafv=None)
Updates a resource file.

Specify the `Content-Type` as `application/octet-stream` or
`multipart/form-data`.

For more information about resource files, see
[Resource files](/api-platform/develop/resource-files).

Args:
  parent: string, Required. Name of the environment in the following format:
  `organizations/{org}/environments/{env}`. (required)
  type: string, Required. Resource file type. {{ resource_file_type }} (required)
  name: string, Required. ID of the resource file to update. Must match the regular
expression: <var>[a-zA-Z0-9:/\\!@#$%^&{}\[\]()+\-=,.~'` ]{1,255}</var> (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.
    "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.
      },
    ],
    "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.
  }

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

Returns:
  An object of the form:

    { # Metadata about a resource file.
    "type": "A String", # Resource file type. {{ resource_file_type }}
    "name": "A String", # ID of the resource file.
  }