grafeas

README

Go API client for grafeas

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

• API version: version not set
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./grafeas"

Documentation for API Endpoints

All URIs are relative to https://localhost

Class	Method	HTTP request	Description
ProjectsApi	ProjectsCreateProject	Post /v1beta1/projects	Creates a new project.
ProjectsApi	ProjectsDeleteProject	Delete /v1beta1/{name}	Deletes the specified project.
ProjectsApi	ProjectsGetProject	Get /v1beta1/{name}	Gets the specified project.
ProjectsApi	ProjectsListProjects	Get /v1beta1/projects	Lists projects.

Documentation For Models

• ProjectListProjectsResponse
• ProjectProject
• ProtobufAny
• RpcStatus

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation

Index

• Variables
• func CacheExpires(r *http.Response) time.Time
• type APIClient
  • func NewAPIClient(cfg *Configuration) *APIClient
  • func (c *APIClient) ChangeBasePath(path string)
• type APIKey
• type APIResponse
  • func NewAPIResponse(r *http.Response) *APIResponse
  • func NewAPIResponseWithError(errorMessage string) *APIResponse
• type BasicAuth
• type Configuration
  • func NewConfiguration() *Configuration
  • func (c *Configuration) AddDefaultHeader(key string, value string)
• type GenericSwaggerError
  • func (e GenericSwaggerError) Body() []byte
  • func (e GenericSwaggerError) Error() string
  • func (e GenericSwaggerError) Model() interface{}
• type ProjectListProjectsResponse
• type ProjectProject
• type ProjectsApiProjectsListProjectsOpts
• type ProjectsApiService
  • func (a *ProjectsApiService) ProjectsCreateProject(ctx context.Context, body ProjectProject) (ProjectProject, *http.Response, error)
  • func (a *ProjectsApiService) ProjectsDeleteProject(ctx context.Context, name string) (interface{}, *http.Response, error)
  • func (a *ProjectsApiService) ProjectsGetProject(ctx context.Context, name string) (ProjectProject, *http.Response, error)
  • func (a *ProjectsApiService) ProjectsListProjects(ctx context.Context, localVarOptionals *ProjectsApiProjectsListProjectsOpts) (ProjectListProjectsResponse, *http.Response, error)
• type ProtobufAny
• type RpcStatus

Variables

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient

type APIClient struct {
	ProjectsApi *ProjectsApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the project.proto API vversion not set In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

type BasicAuth

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader

func (c *Configuration) AddDefaultHeader(key string, value string)

type GenericSwaggerError

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type ProjectListProjectsResponse

type ProjectListProjectsResponse struct {
	// The projects requested.
	Projects []ProjectProject `json:"projects,omitempty"`
	// The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results.
	NextPageToken string `json:"nextPageToken,omitempty"`
}

Response for listing projects.

type ProjectProject

type ProjectProject struct {
	// The name of the project in the form of `projects/{PROJECT_ID}`.
	Name string `json:"name,omitempty"`
}

Describes a Grafeas project.

type ProjectsApiProjectsListProjectsOpts

type ProjectsApiProjectsListProjectsOpts struct {
	Filter    optional.String
	PageSize  optional.Int32
	PageToken optional.String
}

type ProjectsApiService

type ProjectsApiService service

func (*ProjectsApiService) ProjectsCreateProject

func (a *ProjectsApiService) ProjectsCreateProject(ctx context.Context, body ProjectProject) (ProjectProject, *http.Response, error)

ProjectsApiService Creates a new project.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body The project to create.

@return ProjectProject

func (*ProjectsApiService) ProjectsDeleteProject

func (a *ProjectsApiService) ProjectsDeleteProject(ctx context.Context, name string) (interface{}, *http.Response, error)

ProjectsApiService Deletes the specified project.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param name The name of the project in the form of `projects/{PROJECT_ID}`.

@return interface{}

func (*ProjectsApiService) ProjectsGetProject

func (a *ProjectsApiService) ProjectsGetProject(ctx context.Context, name string) (ProjectProject, *http.Response, error)

ProjectsApiService Gets the specified project.

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param name The name of the project in the form of `projects/{PROJECT_ID}`.

@return ProjectProject

func (*ProjectsApiService) ProjectsListProjects

func (a *ProjectsApiService) ProjectsListProjects(ctx context.Context, localVarOptionals *ProjectsApiProjectsListProjectsOpts) (ProjectListProjectsResponse, *http.Response, error)

type ProtobufAny

type ProtobufAny struct {
	Type_ string `json:"@type,omitempty"`
}

type RpcStatus

type RpcStatus struct {
	Code    int32         `json:"code,omitempty"`
	Message string        `json:"message,omitempty"`
	Details []ProtobufAny `json:"details,omitempty"`
}