github.com/goharbor/go-client@v0.210.0/pkg/sdk/v2.0/client/purge/purge_client.go (about)

     1  // Code generated by go-swagger; DO NOT EDIT.
     2  
     3  package purge
     4  
     5  // This file was generated by the swagger tool.
     6  // Editing this file might prove futile when you re-run the swagger generate command
     7  
     8  import (
     9  	"context"
    10  
    11  	"github.com/go-openapi/runtime"
    12  
    13  	strfmt "github.com/go-openapi/strfmt"
    14  )
    15  
    16  //go:generate mockery -name API -inpkg
    17  
    18  // API is the interface of the purge client
    19  type API interface {
    20  	/*
    21  	   CreatePurgeSchedule creates a purge job schedule
    22  
    23  	   This endpoint is for update purge job schedule.
    24  	*/
    25  	CreatePurgeSchedule(ctx context.Context, params *CreatePurgeScheduleParams) (*CreatePurgeScheduleCreated, error)
    26  	/*
    27  	   GetPurgeHistory gets purge job results
    28  
    29  	   get purge job execution history.*/
    30  	GetPurgeHistory(ctx context.Context, params *GetPurgeHistoryParams) (*GetPurgeHistoryOK, error)
    31  	/*
    32  	   GetPurgeJob gets purge job status
    33  
    34  	   This endpoint let user get purge job status filtered by specific ID.*/
    35  	GetPurgeJob(ctx context.Context, params *GetPurgeJobParams) (*GetPurgeJobOK, error)
    36  	/*
    37  	   GetPurgeJobLog gets purge job log
    38  
    39  	   This endpoint let user get purge job logs filtered by specific ID.*/
    40  	GetPurgeJobLog(ctx context.Context, params *GetPurgeJobLogParams) (*GetPurgeJobLogOK, error)
    41  	/*
    42  	   GetPurgeSchedule gets purge s schedule
    43  
    44  	   This endpoint is for get schedule of purge job.*/
    45  	GetPurgeSchedule(ctx context.Context, params *GetPurgeScheduleParams) (*GetPurgeScheduleOK, error)
    46  	/*
    47  	   StopPurge stops the specific purge audit log execution
    48  
    49  	   Stop the purge audit log execution specified by ID*/
    50  	StopPurge(ctx context.Context, params *StopPurgeParams) (*StopPurgeOK, error)
    51  	/*
    52  	   UpdatePurgeSchedule updates purge job s schedule
    53  
    54  	   This endpoint is for update purge job schedule.
    55  	*/
    56  	UpdatePurgeSchedule(ctx context.Context, params *UpdatePurgeScheduleParams) (*UpdatePurgeScheduleOK, error)
    57  }
    58  
    59  // New creates a new purge API client.
    60  func New(transport runtime.ClientTransport, formats strfmt.Registry, authInfo runtime.ClientAuthInfoWriter) *Client {
    61  	return &Client{
    62  		transport: transport,
    63  		formats:   formats,
    64  		authInfo:  authInfo,
    65  	}
    66  }
    67  
    68  /*
    69  Client for purge API
    70  */
    71  type Client struct {
    72  	transport runtime.ClientTransport
    73  	formats   strfmt.Registry
    74  	authInfo  runtime.ClientAuthInfoWriter
    75  }
    76  
    77  /*
    78  CreatePurgeSchedule creates a purge job schedule
    79  
    80  This endpoint is for update purge job schedule.
    81  */
    82  func (a *Client) CreatePurgeSchedule(ctx context.Context, params *CreatePurgeScheduleParams) (*CreatePurgeScheduleCreated, error) {
    83  
    84  	result, err := a.transport.Submit(&runtime.ClientOperation{
    85  		ID:                 "createPurgeSchedule",
    86  		Method:             "POST",
    87  		PathPattern:        "/system/purgeaudit/schedule",
    88  		ProducesMediaTypes: []string{"application/json"},
    89  		ConsumesMediaTypes: []string{"application/json"},
    90  		Schemes:            []string{"http", "https"},
    91  		Params:             params,
    92  		Reader:             &CreatePurgeScheduleReader{formats: a.formats},
    93  		AuthInfo:           a.authInfo,
    94  		Context:            ctx,
    95  		Client:             params.HTTPClient,
    96  	})
    97  	if err != nil {
    98  		return nil, err
    99  	}
   100  	return result.(*CreatePurgeScheduleCreated), nil
   101  
   102  }
   103  
   104  /*
   105  GetPurgeHistory gets purge job results
   106  
   107  get purge job execution history.
   108  */
   109  func (a *Client) GetPurgeHistory(ctx context.Context, params *GetPurgeHistoryParams) (*GetPurgeHistoryOK, error) {
   110  
   111  	result, err := a.transport.Submit(&runtime.ClientOperation{
   112  		ID:                 "getPurgeHistory",
   113  		Method:             "GET",
   114  		PathPattern:        "/system/purgeaudit",
   115  		ProducesMediaTypes: []string{"application/json"},
   116  		ConsumesMediaTypes: []string{"application/json"},
   117  		Schemes:            []string{"http", "https"},
   118  		Params:             params,
   119  		Reader:             &GetPurgeHistoryReader{formats: a.formats},
   120  		AuthInfo:           a.authInfo,
   121  		Context:            ctx,
   122  		Client:             params.HTTPClient,
   123  	})
   124  	if err != nil {
   125  		return nil, err
   126  	}
   127  	return result.(*GetPurgeHistoryOK), nil
   128  
   129  }
   130  
   131  /*
   132  GetPurgeJob gets purge job status
   133  
   134  This endpoint let user get purge job status filtered by specific ID.
   135  */
   136  func (a *Client) GetPurgeJob(ctx context.Context, params *GetPurgeJobParams) (*GetPurgeJobOK, error) {
   137  
   138  	result, err := a.transport.Submit(&runtime.ClientOperation{
   139  		ID:                 "getPurgeJob",
   140  		Method:             "GET",
   141  		PathPattern:        "/system/purgeaudit/{purge_id}",
   142  		ProducesMediaTypes: []string{"application/json"},
   143  		ConsumesMediaTypes: []string{"application/json"},
   144  		Schemes:            []string{"http", "https"},
   145  		Params:             params,
   146  		Reader:             &GetPurgeJobReader{formats: a.formats},
   147  		AuthInfo:           a.authInfo,
   148  		Context:            ctx,
   149  		Client:             params.HTTPClient,
   150  	})
   151  	if err != nil {
   152  		return nil, err
   153  	}
   154  	return result.(*GetPurgeJobOK), nil
   155  
   156  }
   157  
   158  /*
   159  GetPurgeJobLog gets purge job log
   160  
   161  This endpoint let user get purge job logs filtered by specific ID.
   162  */
   163  func (a *Client) GetPurgeJobLog(ctx context.Context, params *GetPurgeJobLogParams) (*GetPurgeJobLogOK, error) {
   164  
   165  	result, err := a.transport.Submit(&runtime.ClientOperation{
   166  		ID:                 "getPurgeJobLog",
   167  		Method:             "GET",
   168  		PathPattern:        "/system/purgeaudit/{purge_id}/log",
   169  		ProducesMediaTypes: []string{"text/plain"},
   170  		ConsumesMediaTypes: []string{"application/json"},
   171  		Schemes:            []string{"http", "https"},
   172  		Params:             params,
   173  		Reader:             &GetPurgeJobLogReader{formats: a.formats},
   174  		AuthInfo:           a.authInfo,
   175  		Context:            ctx,
   176  		Client:             params.HTTPClient,
   177  	})
   178  	if err != nil {
   179  		return nil, err
   180  	}
   181  	return result.(*GetPurgeJobLogOK), nil
   182  
   183  }
   184  
   185  /*
   186  GetPurgeSchedule gets purge s schedule
   187  
   188  This endpoint is for get schedule of purge job.
   189  */
   190  func (a *Client) GetPurgeSchedule(ctx context.Context, params *GetPurgeScheduleParams) (*GetPurgeScheduleOK, error) {
   191  
   192  	result, err := a.transport.Submit(&runtime.ClientOperation{
   193  		ID:                 "getPurgeSchedule",
   194  		Method:             "GET",
   195  		PathPattern:        "/system/purgeaudit/schedule",
   196  		ProducesMediaTypes: []string{"application/json"},
   197  		ConsumesMediaTypes: []string{"application/json"},
   198  		Schemes:            []string{"http", "https"},
   199  		Params:             params,
   200  		Reader:             &GetPurgeScheduleReader{formats: a.formats},
   201  		AuthInfo:           a.authInfo,
   202  		Context:            ctx,
   203  		Client:             params.HTTPClient,
   204  	})
   205  	if err != nil {
   206  		return nil, err
   207  	}
   208  	return result.(*GetPurgeScheduleOK), nil
   209  
   210  }
   211  
   212  /*
   213  StopPurge stops the specific purge audit log execution
   214  
   215  Stop the purge audit log execution specified by ID
   216  */
   217  func (a *Client) StopPurge(ctx context.Context, params *StopPurgeParams) (*StopPurgeOK, error) {
   218  
   219  	result, err := a.transport.Submit(&runtime.ClientOperation{
   220  		ID:                 "stopPurge",
   221  		Method:             "PUT",
   222  		PathPattern:        "/system/purgeaudit/{purge_id}",
   223  		ProducesMediaTypes: []string{"application/json"},
   224  		ConsumesMediaTypes: []string{"application/json"},
   225  		Schemes:            []string{"http", "https"},
   226  		Params:             params,
   227  		Reader:             &StopPurgeReader{formats: a.formats},
   228  		AuthInfo:           a.authInfo,
   229  		Context:            ctx,
   230  		Client:             params.HTTPClient,
   231  	})
   232  	if err != nil {
   233  		return nil, err
   234  	}
   235  	return result.(*StopPurgeOK), nil
   236  
   237  }
   238  
   239  /*
   240  UpdatePurgeSchedule updates purge job s schedule
   241  
   242  This endpoint is for update purge job schedule.
   243  */
   244  func (a *Client) UpdatePurgeSchedule(ctx context.Context, params *UpdatePurgeScheduleParams) (*UpdatePurgeScheduleOK, error) {
   245  
   246  	result, err := a.transport.Submit(&runtime.ClientOperation{
   247  		ID:                 "updatePurgeSchedule",
   248  		Method:             "PUT",
   249  		PathPattern:        "/system/purgeaudit/schedule",
   250  		ProducesMediaTypes: []string{"application/json"},
   251  		ConsumesMediaTypes: []string{"application/json"},
   252  		Schemes:            []string{"http", "https"},
   253  		Params:             params,
   254  		Reader:             &UpdatePurgeScheduleReader{formats: a.formats},
   255  		AuthInfo:           a.authInfo,
   256  		Context:            ctx,
   257  		Client:             params.HTTPClient,
   258  	})
   259  	if err != nil {
   260  		return nil, err
   261  	}
   262  	return result.(*UpdatePurgeScheduleOK), nil
   263  
   264  }